Skip to content
代码片段 群组 项目
提交 d89de55b 编辑于 作者: Ashraf Khamis's avatar Ashraf Khamis 提交者: Lorena Ciutacu
浏览文件

Standardize command line in docs

上级 cb6dead0
No related branches found
No related tags found
无相关合并请求
显示
26 个添加26 个删除
......@@ -160,9 +160,9 @@ GitLab uses Redis both as a cache store and to hold persistent data for our back
Elasticsearch is an optional database for advanced search. It can improve search
in both source-code level, and user generated content in issues, merge requests, and discussions. The [backup command](#backup-command) does _not_ back up Elasticsearch data. Elasticsearch data can be regenerated from PostgreSQL data after a restore. It is possible to [manually back up Elasticsearch](https://www.elastic.co/guide/en/elasticsearch/reference/current/snapshot-restore.html).
## Command line interface
## Command-line interface
GitLab provides a command line interface to back up your entire instance,
GitLab provides a command-line interface to back up your entire instance,
including:
- Database
......@@ -301,7 +301,7 @@ the timestamp is `1493107454_2018_04_25_10.6.4-ce`.
### Backup options
The command line tool GitLab provides to back up your instance can accept more
The command-line tool GitLab provides to back up your instance can accept more
options.
#### Backup strategy option
......
......@@ -6,7 +6,7 @@ info: To determine the technical writer assigned to the Stage/Group associated w
# Restore GitLab **(FREE SELF)**
GitLab provides a command line interface to restore your entire installation,
GitLab provides a command-line interface to restore your entire installation,
and is flexible enough to fit your needs.
The [restore prerequisites section](#restore-prerequisites) includes crucial
......@@ -287,7 +287,7 @@ Each backup archive contains a full self-contained backup, including those creat
## Restore options
The command line tool GitLab provides to restore from backup can accept more
The command-line tool GitLab provides to restore from backup can accept more
options.
### Specify backup to restore when there are more than one
......
......@@ -246,7 +246,7 @@ Linux package-managed database. External databases are not supported.
In some circumstances, like during [upgrades](replication/upgrading_the_geo_sites.md) or a
[planned failover](disaster_recovery/planned_failover.md), it is desirable to pause replication between the primary and secondary.
Pausing and resuming replication is done via a command line tool from the node in the secondary site where the `postgresql` service is enabled.
Pausing and resuming replication is done through a command-line tool from the node in the secondary site where the `postgresql` service is enabled.
If `postgresql` is on a standalone database node, ensure that `gitlab.rb` on that node contains the configuration line `gitlab_rails['geo_node_name'] = 'node_name'`, where `node_name` is the same as the `geo_node_name` on the application node.
......
......@@ -269,7 +269,7 @@ git push origin +refs/heads/*:refs/heads/* +refs/tags/*:refs/tags/*
Any other namespaces that the administrator wants to push can be included there as well via additional patterns.
### Command line tools cannot connect to Gitaly
### Command-line tools cannot connect to Gitaly
gRPC cannot reach your Gitaly server if:
......
......@@ -104,7 +104,7 @@ Step Runner:
- Step Runner is responsible for parsing and compiling GitLab Steps and GitHub Actions.
- Step Runner is responsible for downloading, and managing repositories required by GitLab Steps and GitHub Actions.
- Step Runner does control and monitor execution flow of individual steps of execution.
- Step Runner is required to be executable via command line interface (CLI). It means that it can be configured either via config file,
- Step Runner is required to be executable from the command-line interface (CLI). It means that it can be configured either via config file,
or environment file, or be able to read `.gitlab-ci.yml`.
- Step Runner can expose gRPC or other programmable interface to run config or get trace from.
......
......@@ -181,7 +181,7 @@ See also [Docker Tagging: Best practices for tagging and versioning Docker image
## Command line
A scanner is a command line tool that takes environment variables as inputs,
A scanner is a command-line tool that takes environment variables as inputs,
and generates a file that is uploaded as a report (based on the job definition).
It also generates text output on the standard output and standard error streams, and exits with a status code.
......
......@@ -250,7 +250,7 @@ the timeout.
Once profiling stops, the profile is written out to disk at
`$STACKPROF_FILE_PREFIX/stackprof.$PID.$RAND.profile`. It can then be inspected
further through the `stackprof` command line tool, as described in the
further through the `stackprof` command-line tool, as described in the
[Reading a Stackprof profile section](#reading-a-stackprof-profile).
Currently supported profiling targets are:
......
......@@ -88,7 +88,7 @@ cat: illegal option -- l
usage: cat [-benstuv] [file ...]
```
In the example above, the argument parser of `cat` assumes that `-l` is an option. The solution in the example above is to make it clear to `cat` that `-l` is really an argument, not an option. Many Unix command line tools follow the convention of separating options from arguments with `--`.
In the example above, the argument parser of `cat` assumes that `-l` is an option. The solution in the example above is to make it clear to `cat` that `-l` is really an argument, not an option. Many Unix command-line tools follow the convention of separating options from arguments with `--`.
```shell
# Example (continued)
......
......@@ -367,7 +367,7 @@ If the _only_ action in the test that requires administrator access is to toggle
In line with [using the API](#prefer-api-over-ui), use a `Commit` resource whenever possible.
`ProjectPush` uses raw shell commands via the Git Command Line Interface (CLI) whereas the `Commit` resource makes an HTTP request.
`ProjectPush` uses raw shell commands from the Git command-line interface (CLI), and the `Commit` resource makes an HTTP request.
```ruby
# Using a commit resource
......
......@@ -278,7 +278,7 @@ find a way to limit it to only us.**
- [Review apps integration for CE/EE (presentation)](https://docs.google.com/presentation/d/1QPLr6FO4LduROU8pQIPkX1yfGvD13GEJIBOenqoKxR8/edit?usp=sharing)
- [Stability issues](https://gitlab.com/gitlab-org/quality/quality-engineering/team-tasks/-/issues/212)
### Helpful command line tools
### Helpful command-line tools
- [K9s](https://github.com/derailed/k9s) - enables CLI dashboard across pods and enabling filtering by labels
- [Stern](https://github.com/wercker/stern) - enables cross pod log tailing based on label/field selectors
......
......@@ -13,7 +13,7 @@ GitLab has plugins and extensions to extend GitLab functionality to the followin
- [Visual Studio](visual_studio/index.md)
- [Neovim](neovim/index.md)
GitLab also supports developers in their command line interface with [`glab`](gitlab_cli/index.md) the GitLab CLI.
GitLab also supports developers in their command-line interface with [`glab`](gitlab_cli/index.md) the GitLab CLI.
## Features
......
......@@ -224,7 +224,7 @@ sudo chown mattermost:mattermost /var/opt/gitlab/mattermost/config.json
sudo gitlab-ctl start mattermost
```
## Mattermost Command Line Tools (CLI)
## Mattermost command-line tool (CLI)
[`mmctl`](https://docs.mattermost.com/manage/mmctl-command-line-tool.html) is a CLI tool for the Mattermost server which is installed locally and uses the Mattermost API, but may also be used remotely. You must configure Mattermost either for local connections or authenticate as an administrator with local login credentials (not through GitLab SSO). The executable is located at `/opt/gitlab/embedded/bin/mmctl`.
......
......@@ -34,16 +34,16 @@ Prerequisites:
To install Git on macOS:
1. Open a terminal and install the XCode Command Line Tools:
1. Open a terminal and install Xcode Command Line Tools:
```shell
xcode-select --install
```
Alternatively, you can install the entire [XCode](https://developer.apple.com/xcode/)
Alternatively, you can install the entire [Xcode](https://developer.apple.com/xcode/)
package through the macOS App Store.
1. Select **Install** to download and install XCode Command Line Tools.
1. Select **Install** to download and install Xcode Command Line Tools.
1. Install Homebrew according to the [official Homebrew installation instructions](https://brew.sh/index.html).
1. Install Git by running `brew install git` from your terminal.
1. In a terminal, verify that Git works on your computer:
......
......@@ -12,7 +12,7 @@ that your commit message didn't completely align with a project's
[commit message guidelines](../../development/contributing/merge_request_workflow.md#commit-messages-guidelines).
Updating the message can be tricky if you don't have much practice with using Git
from the command line interface (CLI). But don't worry, even if you have only ever worked in
from the command-line interface (CLI). But don't worry, even if you have only ever worked in
the GitLab UI, we'll walk you through the steps to use the CLI.
This tutorial explains how to rewrite commit messages in both cases:
......@@ -33,7 +33,7 @@ You must have:
- A GitLab project with a Git branch containing commits that you want to update.
- Git [installed on your local machine](../../topics/git/how_to_install_git/index.md).
- The ability to get to your local machine's command line interface (CLI). In macOS,
- The ability to get to your local machine's command-line interface (CLI). In macOS,
you can use Terminal. In Windows, you can use PowerShell. Linux users are probably
already familiar with their system's CLI.
- Familiarity with your system's default editor. This tutorial assumes your editor is Vim,
......
......@@ -90,7 +90,7 @@ After you have successfully installed Vault, you must
and obtain the initial root token. You need access to your Kubernetes cluster that
Vault has been deployed into to do this. To initialize the Vault, get a
shell to one of the Vault pods running inside Kubernetes (typically this is done
by using the `kubectl` command line tool). After you have a shell into the pod,
by using the `kubectl` command-line tool). After you have a shell into the pod,
run the `vault operator init` command:
```shell
......
......@@ -151,7 +151,7 @@ You can push files to GitLab whether they're locked or unlocked.
NOTE:
Although multi-branch file locks can be created and managed through the Git LFS
command line interface, file locks can be created for any file.
command-line interface, file locks can be created for any file.
### View exclusively-locked files
......
......@@ -7,7 +7,7 @@ info: To determine the technical writer assigned to the Stage/Group associated w
# GitLab Release CLI tool
The [GitLab Release CLI (`release-cli`)](https://gitlab.com/gitlab-org/release-cli) tool
The [GitLab Release CLI (`release-cli`)](https://gitlab.com/gitlab-org/release-cli)
is a command-line tool for managing releases from the command line or from a CI/CD pipeline.
You can use the release CLI to create, update, modify, and delete releases.
......
......@@ -73,7 +73,7 @@ into Xcode on macOS.
1. Select **Xcode**.
The project is cloned onto your computer and you are
prompted to open XCode.
prompted to open Xcode.
### Clone and open in Visual Studio Code
......
......@@ -28,7 +28,7 @@ You must use the following scopes to [authenticate](../api/rest/index.md#authent
- Full API access with the `api` scope.
- At least the Maintainer role on all projects.
You can use command line tools or a programming language to interact with the REST API.
You can use command-line tools or a programming language to interact with the REST API.
### Command line
......
......@@ -200,7 +200,7 @@ If your total namespace storage exceeds the available namespace storage quota, a
To notify you that you have nearly exceeded your namespace storage quota:
- In the command line interface, a notification displays after each `git push` action when you've reached 95% and 100% of your namespace storage quota.
- In the command-line interface, a notification displays after each `git push` action when you've reached 95% and 100% of your namespace storage quota.
- In the GitLab UI, a notification displays when you've reached 75%, 95%, and 100% of your namespace storage quota.
- GitLab sends an email to members with the Owner role to notify them when namespace storage usage is at 70%, 85%, 95%, and 100%.
......
0% 加载中 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册