Commit 04e3c6cc authored by Evan Read's avatar Evan Read

Merge branch 'docs-20200121-fenced-blocks3' into 'master'

Add language tags to code blocks for linting

See merge request gitlab-org/gitlab!23470
parents 1bb518b4 9f246f4c
...@@ -105,7 +105,7 @@ bundle exec rake file_hooks:validate RAILS_ENV=production ...@@ -105,7 +105,7 @@ bundle exec rake file_hooks:validate RAILS_ENV=production
Example of output: Example of output:
``` ```plaintext
Validating file hooks from /plugins directory Validating file hooks from /plugins directory
* /home/git/gitlab/plugins/save_to_file.clj succeed (zero exit code) * /home/git/gitlab/plugins/save_to_file.clj succeed (zero exit code)
* /home/git/gitlab/plugins/save_to_file.rb failure (non-zero exit code) * /home/git/gitlab/plugins/save_to_file.rb failure (non-zero exit code)
......
...@@ -98,7 +98,7 @@ The Pages daemon doesn't listen to the outside world. ...@@ -98,7 +98,7 @@ The Pages daemon doesn't listen to the outside world.
1. Install the Pages daemon: 1. Install the Pages daemon:
``` ```bash
cd /home/git cd /home/git
sudo -u git -H git clone https://gitlab.com/gitlab-org/gitlab-pages.git sudo -u git -H git clone https://gitlab.com/gitlab-org/gitlab-pages.git
cd gitlab-pages cd gitlab-pages
...@@ -160,7 +160,7 @@ outside world. ...@@ -160,7 +160,7 @@ outside world.
1. Install the Pages daemon: 1. Install the Pages daemon:
``` ```bash
cd /home/git cd /home/git
sudo -u git -H git clone https://gitlab.com/gitlab-org/gitlab-pages.git sudo -u git -H git clone https://gitlab.com/gitlab-org/gitlab-pages.git
cd gitlab-pages cd gitlab-pages
...@@ -225,7 +225,7 @@ world. Custom domains are supported, but no TLS. ...@@ -225,7 +225,7 @@ world. Custom domains are supported, but no TLS.
1. Install the Pages daemon: 1. Install the Pages daemon:
``` ```bash
cd /home/git cd /home/git
sudo -u git -H git clone https://gitlab.com/gitlab-org/gitlab-pages.git sudo -u git -H git clone https://gitlab.com/gitlab-org/gitlab-pages.git
cd gitlab-pages cd gitlab-pages
...@@ -290,7 +290,7 @@ world. Custom domains and TLS are supported. ...@@ -290,7 +290,7 @@ world. Custom domains and TLS are supported.
1. Install the Pages daemon: 1. Install the Pages daemon:
``` ```bash
cd /home/git cd /home/git
sudo -u git -H git clone https://gitlab.com/gitlab-org/gitlab-pages.git sudo -u git -H git clone https://gitlab.com/gitlab-org/gitlab-pages.git
cd gitlab-pages cd gitlab-pages
...@@ -353,20 +353,20 @@ not remove the backslashes. ...@@ -353,20 +353,20 @@ not remove the backslashes.
If your GitLab Pages domain is `example.io`, replace: If your GitLab Pages domain is `example.io`, replace:
```bash ```nginx
server_name ~^.*\.YOUR_GITLAB_PAGES\.DOMAIN$; server_name ~^.*\.YOUR_GITLAB_PAGES\.DOMAIN$;
``` ```
with: with:
``` ```nginx
server_name ~^.*\.example\.io$; server_name ~^.*\.example\.io$;
``` ```
If you are using a subdomain, make sure to escape all dots (`.`) except from If you are using a subdomain, make sure to escape all dots (`.`) except from
the first one with a backslash (\). For example `pages.example.io` would be: the first one with a backslash (\). For example `pages.example.io` would be:
``` ```nginx
server_name ~^.*\.pages\.example\.io$; server_name ~^.*\.pages\.example\.io$;
``` ```
......
...@@ -33,7 +33,7 @@ integrity check described previously. ...@@ -33,7 +33,7 @@ integrity check described previously.
**Omnibus Installation** **Omnibus Installation**
``` ```bash
sudo gitlab-rake gitlab:git:fsck sudo gitlab-rake gitlab:git:fsck
``` ```
...@@ -58,7 +58,7 @@ Currently, integrity checks are supported for the following types of file: ...@@ -58,7 +58,7 @@ Currently, integrity checks are supported for the following types of file:
**Omnibus Installation** **Omnibus Installation**
``` ```bash
sudo gitlab-rake gitlab:artifacts:check sudo gitlab-rake gitlab:artifacts:check
sudo gitlab-rake gitlab:lfs:check sudo gitlab-rake gitlab:lfs:check
sudo gitlab-rake gitlab:uploads:check sudo gitlab-rake gitlab:uploads:check
...@@ -90,7 +90,7 @@ sudo gitlab-rake gitlab:uploads:check BATCH=100 ID_FROM=50 ID_TO=250 ...@@ -90,7 +90,7 @@ sudo gitlab-rake gitlab:uploads:check BATCH=100 ID_FROM=50 ID_TO=250
Example output: Example output:
``` ```bash
$ sudo gitlab-rake gitlab:uploads:check $ sudo gitlab-rake gitlab:uploads:check
Checking integrity of Uploads Checking integrity of Uploads
- 1..1350: Failures: 0 - 1..1350: Failures: 0
...@@ -107,7 +107,7 @@ Done! ...@@ -107,7 +107,7 @@ Done!
Example verbose output: Example verbose output:
``` ```bash
$ sudo gitlab-rake gitlab:uploads:check VERBOSE=1 $ sudo gitlab-rake gitlab:uploads:check VERBOSE=1
Checking integrity of Uploads Checking integrity of Uploads
- 1..1350: Failures: 0 - 1..1350: Failures: 0
......
...@@ -11,7 +11,7 @@ This is equivalent of running `git repack -d` on a _bare_ repository. ...@@ -11,7 +11,7 @@ This is equivalent of running `git repack -d` on a _bare_ repository.
**Omnibus Installation** **Omnibus Installation**
``` ```bash
sudo gitlab-rake geo:git:housekeeping:incremental_repack sudo gitlab-rake geo:git:housekeeping:incremental_repack
``` ```
...@@ -29,7 +29,7 @@ when this is enabled in GitLab. ...@@ -29,7 +29,7 @@ when this is enabled in GitLab.
**Omnibus Installation** **Omnibus Installation**
``` ```bash
sudo gitlab-rake geo:git:housekeeping:full_repack sudo gitlab-rake geo:git:housekeeping:full_repack
``` ```
...@@ -46,7 +46,7 @@ a reachability bitmap index when this is enabled in GitLab. ...@@ -46,7 +46,7 @@ a reachability bitmap index when this is enabled in GitLab.
**Omnibus Installation** **Omnibus Installation**
``` ```bash
sudo gitlab-rake geo:git:housekeeping:gc sudo gitlab-rake geo:git:housekeeping:gc
``` ```
...@@ -63,7 +63,7 @@ can remove them using the rake task `geo:run_orphaned_project_registry_cleaner`: ...@@ -63,7 +63,7 @@ can remove them using the rake task `geo:run_orphaned_project_registry_cleaner`:
**Omnibus Installation** **Omnibus Installation**
``` ```bash
sudo gitlab-rake geo:run_orphaned_project_registry_cleaner sudo gitlab-rake geo:run_orphaned_project_registry_cleaner
``` ```
......
...@@ -9,7 +9,7 @@ using the command below. ...@@ -9,7 +9,7 @@ using the command below.
**Omnibus Installation** **Omnibus Installation**
``` ```bash
sudo gitlab-rake gitlab:ldap:check sudo gitlab-rake gitlab:ldap:check
``` ```
...@@ -41,7 +41,7 @@ instead. ...@@ -41,7 +41,7 @@ instead.
**Omnibus Installation** **Omnibus Installation**
``` ```bash
sudo gitlab-rake gitlab:ldap:group_sync sudo gitlab-rake gitlab:ldap:group_sync
``` ```
...@@ -101,7 +101,7 @@ sudo gitlab-rake gitlab:ldap:rename_provider[ldapmain,ldapmycompany] ...@@ -101,7 +101,7 @@ sudo gitlab-rake gitlab:ldap:rename_provider[ldapmain,ldapmycompany]
Example output: Example output:
``` ```plaintext
100 users with provider 'ldapmain' will be updated to 'ldapmycompany'. 100 users with provider 'ldapmain' will be updated to 'ldapmycompany'.
If the new provider is incorrect, users will be unable to sign in. If the new provider is incorrect, users will be unable to sign in.
Do you want to continue (yes/no)? yes Do you want to continue (yes/no)? yes
...@@ -128,7 +128,7 @@ bundle exec rake gitlab:ldap:rename_provider RAILS_ENV=production ...@@ -128,7 +128,7 @@ bundle exec rake gitlab:ldap:rename_provider RAILS_ENV=production
**Example output:** **Example output:**
``` ```plaintext
What is the old provider? Ex. 'ldapmain': ldapmain What is the old provider? Ex. 'ldapmain': ldapmain
What is the new provider? Ex. 'ldapcustom': ldapmycompany What is the new provider? Ex. 'ldapcustom': ldapmycompany
``` ```
......
...@@ -6,19 +6,19 @@ This command gathers information about your GitLab installation and the System i ...@@ -6,19 +6,19 @@ This command gathers information about your GitLab installation and the System i
**Omnibus Installation** **Omnibus Installation**
``` ```bash
sudo gitlab-rake gitlab:env:info sudo gitlab-rake gitlab:env:info
``` ```
**Source Installation** **Source Installation**
``` ```bash
bundle exec rake gitlab:env:info RAILS_ENV=production bundle exec rake gitlab:env:info RAILS_ENV=production
``` ```
Example output: Example output:
``` ```plaintext
System information System information
System: Debian 7.8 System: Debian 7.8
Current User: git Current User: git
...@@ -66,13 +66,13 @@ You may also have a look at our Troubleshooting Guides: ...@@ -66,13 +66,13 @@ You may also have a look at our Troubleshooting Guides:
**Omnibus Installation** **Omnibus Installation**
``` ```bash
sudo gitlab-rake gitlab:check sudo gitlab-rake gitlab:check
``` ```
**Source Installation** **Source Installation**
``` ```bash
bundle exec rake gitlab:check RAILS_ENV=production bundle exec rake gitlab:check RAILS_ENV=production
``` ```
...@@ -80,7 +80,7 @@ NOTE: Use `SANITIZE=true` for `gitlab:check` if you want to omit project names f ...@@ -80,7 +80,7 @@ NOTE: Use `SANITIZE=true` for `gitlab:check` if you want to omit project names f
Example output: Example output:
``` ```plaintext
Checking Environment ... Checking Environment ...
Git configured for git user? ... yes Git configured for git user? ... yes
...@@ -129,18 +129,18 @@ In some case it is necessary to rebuild the `authorized_keys` file. ...@@ -129,18 +129,18 @@ In some case it is necessary to rebuild the `authorized_keys` file.
**Omnibus Installation** **Omnibus Installation**
``` ```bash
sudo gitlab-rake gitlab:shell:setup sudo gitlab-rake gitlab:shell:setup
``` ```
**Source Installation** **Source Installation**
``` ```bash
cd /home/git/gitlab cd /home/git/gitlab
sudo -u git -H bundle exec rake gitlab:shell:setup RAILS_ENV=production sudo -u git -H bundle exec rake gitlab:shell:setup RAILS_ENV=production
``` ```
``` ```plaintext
This will rebuild an authorized_keys file. This will rebuild an authorized_keys file.
You will lose any data stored in authorized_keys file. You will lose any data stored in authorized_keys file.
Do you want to continue (yes/no)? yes Do you want to continue (yes/no)? yes
...@@ -153,13 +153,13 @@ clear Redis' cache. ...@@ -153,13 +153,13 @@ clear Redis' cache.
**Omnibus Installation** **Omnibus Installation**
``` ```bash
sudo gitlab-rake cache:clear sudo gitlab-rake cache:clear
``` ```
**Source Installation** **Source Installation**
``` ```bash
cd /home/git/gitlab cd /home/git/gitlab
sudo -u git -H bundle exec rake cache:clear RAILS_ENV=production sudo -u git -H bundle exec rake cache:clear RAILS_ENV=production
``` ```
...@@ -174,7 +174,7 @@ Omnibus packages. ...@@ -174,7 +174,7 @@ Omnibus packages.
**Source Installation** **Source Installation**
``` ```bash
cd /home/git/gitlab cd /home/git/gitlab
sudo -u git -H bundle exec rake gitlab:assets:compile RAILS_ENV=production sudo -u git -H bundle exec rake gitlab:assets:compile RAILS_ENV=production
``` ```
...@@ -194,13 +194,13 @@ in the GitLab Performance Monitoring database. ...@@ -194,13 +194,13 @@ in the GitLab Performance Monitoring database.
**Omnibus Installation** **Omnibus Installation**
``` ```bash
sudo gitlab-rake gitlab:track_deployment sudo gitlab-rake gitlab:track_deployment
``` ```
**Source Installation** **Source Installation**
``` ```bash
cd /home/git/gitlab cd /home/git/gitlab
sudo -u git -H bundle exec rake gitlab:track_deployment RAILS_ENV=production sudo -u git -H bundle exec rake gitlab:track_deployment RAILS_ENV=production
``` ```
...@@ -213,13 +213,13 @@ is included to help you with this: ...@@ -213,13 +213,13 @@ is included to help you with this:
**Omnibus Installation** **Omnibus Installation**
``` ```bash
sudo gitlab-rake gitlab:tcp_check[example.com,80] sudo gitlab-rake gitlab:tcp_check[example.com,80]
``` ```
**Source Installation** **Source Installation**
``` ```bash
cd /home/git/gitlab cd /home/git/gitlab
sudo -u git -H bundle exec rake gitlab:tcp_check[example.com,80] RAILS_ENV=production sudo -u git -H bundle exec rake gitlab:tcp_check[example.com,80] RAILS_ENV=production
``` ```
...@@ -279,6 +279,6 @@ This could be as a result of [updating existing metrics](../../development/prome ...@@ -279,6 +279,6 @@ This could be as a result of [updating existing metrics](../../development/prome
To re-import the metrics you can run: To re-import the metrics you can run:
```sh ```bash
sudo gitlab-rake metrics:setup_common_metrics sudo gitlab-rake metrics:setup_common_metrics
``` ```
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment