Commit addcbdc3 authored by Marcel Amirault's avatar Marcel Amirault

Merge branch 'docs-aqualls-20200305-codeblocks' into 'master'

Docs: Add language declarations to code blocks

See merge request gitlab-org/gitlab!26628
parents 01130251 fe19300a
...@@ -54,7 +54,7 @@ Authenticate to GitLab using the Atlassian Crowd OmniAuth provider. ...@@ -54,7 +54,7 @@ Authenticate to GitLab using the Atlassian Crowd OmniAuth provider.
**Source:** **Source:**
``` ```yaml
- { name: 'crowd', - { name: 'crowd',
args: { args: {
crowd_server_url: 'CROWD_SERVER_URL', crowd_server_url: 'CROWD_SERVER_URL',
......
...@@ -405,7 +405,7 @@ production: ...@@ -405,7 +405,7 @@ production:
Tip: If you want to limit access to the nested members of an Active Directory Tip: If you want to limit access to the nested members of an Active Directory
group, you can use the following syntax: group, you can use the following syntax:
```text ```plaintext
(memberOf:1.2.840.113556.1.4.1941:=CN=My Group,DC=Example,DC=com) (memberOf:1.2.840.113556.1.4.1941:=CN=My Group,DC=Example,DC=com)
``` ```
...@@ -423,13 +423,13 @@ The `user_filter` DN can contain special characters. For example: ...@@ -423,13 +423,13 @@ The `user_filter` DN can contain special characters. For example:
- A comma: - A comma:
```text ```plaintext
OU=GitLab, Inc,DC=gitlab,DC=com OU=GitLab, Inc,DC=gitlab,DC=com
``` ```
- Open and close brackets: - Open and close brackets:
```text ```plaintext
OU=Gitlab (Inc),DC=gitlab,DC=com OU=Gitlab (Inc),DC=gitlab,DC=com
``` ```
...@@ -438,13 +438,13 @@ The `user_filter` DN can contain special characters. For example: ...@@ -438,13 +438,13 @@ The `user_filter` DN can contain special characters. For example:
- Escape commas with `\2C`. For example: - Escape commas with `\2C`. For example:
```text ```plaintext
OU=GitLab\2C Inc,DC=gitlab,DC=com OU=GitLab\2C Inc,DC=gitlab,DC=com
``` ```
- Escape open and close brackets with `\28` and `\29`, respectively. For example: - Escape open and close brackets with `\28` and `\29`, respectively. For example:
```text ```plaintext
OU=Gitlab \28Inc\29,DC=gitlab,DC=com OU=Gitlab \28Inc\29,DC=gitlab,DC=com
``` ```
...@@ -603,7 +603,7 @@ GitLab. Common combinations are `encryption: 'plain'` and `port: 389`, OR ...@@ -603,7 +603,7 @@ GitLab. Common combinations are `encryption: 'plain'` and `port: 389`, OR
If GitLab cannot reach your LDAP endpoint, you will see a message like this: If GitLab cannot reach your LDAP endpoint, you will see a message like this:
``` ```plaintext
Could not authenticate you from Ldapmain because "Connection timed out - user specified timeout". Could not authenticate you from Ldapmain because "Connection timed out - user specified timeout".
``` ```
......
...@@ -495,7 +495,7 @@ work: ...@@ -495,7 +495,7 @@ work:
1. On the **secondary** nodes, change `/etc/gitlab/gitlab.rb`: 1. On the **secondary** nodes, change `/etc/gitlab/gitlab.rb`:
``` ```ruby
geo_postgresql['fdw_external_user'] = 'gitlab_geo_fdw' geo_postgresql['fdw_external_user'] = 'gitlab_geo_fdw'
``` ```
......
...@@ -43,13 +43,13 @@ configuration options required to enable it. ...@@ -43,13 +43,13 @@ configuration options required to enable it.
For Debian-like systems (for example, Debian and Ubuntu) this can be achieved by running: For Debian-like systems (for example, Debian and Ubuntu) this can be achieved by running:
``` ```shell
sudo apt-get update && sudo apt-get install git-annex sudo apt-get update && sudo apt-get install git-annex
``` ```
For RedHat-like systems (for example, CentOS and RHEL) this can be achieved by running: For RedHat-like systems (for example, CentOS and RHEL) this can be achieved by running:
``` ```shell
sudo yum install epel-release && sudo yum install git-annex sudo yum install epel-release && sudo yum install git-annex
``` ```
...@@ -108,7 +108,7 @@ git annex sync --content # sync the Git repo and large file to the GitLa ...@@ -108,7 +108,7 @@ git annex sync --content # sync the Git repo and large file to the GitLa
The output should look like this: The output should look like this:
``` ```plaintext
commit commit
On branch master On branch master
Your branch is ahead of 'origin/master' by 1 commit. Your branch is ahead of 'origin/master' by 1 commit.
...@@ -154,7 +154,7 @@ are turned into symbolic links that point to data in `.git/annex/objects/`. ...@@ -154,7 +154,7 @@ are turned into symbolic links that point to data in `.git/annex/objects/`.
The `debian.iso` file in the example will contain the symbolic link: The `debian.iso` file in the example will contain the symbolic link:
``` ```plaintext
.git/annex/objects/ZW/1k/SHA256E-s82701--6384039733b5035b559efd5a2e25a493ab6e09aabfd5162cc03f6f0ec238429d.png/SHA256E-s82701--6384039733b5035b559efd5a2e25a493ab6e09aabfd5162cc03f6f0ec238429d.iso .git/annex/objects/ZW/1k/SHA256E-s82701--6384039733b5035b559efd5a2e25a493ab6e09aabfd5162cc03f6f0ec238429d.png/SHA256E-s82701--6384039733b5035b559efd5a2e25a493ab6e09aabfd5162cc03f6f0ec238429d.iso
``` ```
...@@ -216,14 +216,14 @@ and the files are pushed to the GitLab repository. ...@@ -216,14 +216,14 @@ and the files are pushed to the GitLab repository.
If you get hit by this, you can run the following command inside the repository If you get hit by this, you can run the following command inside the repository
that the warning was raised: that the warning was raised:
``` ```shell
git config remote.origin.annex-ignore false git config remote.origin.annex-ignore false
``` ```
Consecutive runs of `git annex sync --content` **should not** produce this Consecutive runs of `git annex sync --content` **should not** produce this
warning and the output should look like this: warning and the output should look like this:
``` ```plaintext
commit ok commit ok
pull origin pull origin
ok ok
......
...@@ -57,7 +57,7 @@ Fire up a terminal, navigate to your Git repository and: ...@@ -57,7 +57,7 @@ Fire up a terminal, navigate to your Git repository and:
1. Enable `git-lfs`: 1. Enable `git-lfs`:
``` ```shell
git lfs install git lfs install
git lfs track <files> git lfs track <files>
git add . git add .
......
...@@ -353,7 +353,7 @@ GitLab uses background jobs for processing tasks which can take a long ...@@ -353,7 +353,7 @@ GitLab uses background jobs for processing tasks which can take a long
time. All information about processing these jobs are written down to time. All information about processing these jobs are written down to
this file. For example: this file. For example:
``` ```plaintext
2014-06-10T07:55:20Z 2037 TID-tm504 ERROR: /opt/bitnami/apps/discourse/htdocs/vendor/bundle/ruby/1.9.1/gems/redis-3.0.7/lib/redis/client.rb:228:in `read' 2014-06-10T07:55:20Z 2037 TID-tm504 ERROR: /opt/bitnami/apps/discourse/htdocs/vendor/bundle/ruby/1.9.1/gems/redis-3.0.7/lib/redis/client.rb:228:in `read'
2014-06-10T18:18:26Z 14299 TID-55uqo INFO: Booting Sidekiq 3.0.0 with redis options {:url=>"redis://localhost:6379/0", :namespace=>"sidekiq"} 2014-06-10T18:18:26Z 14299 TID-55uqo INFO: Booting Sidekiq 3.0.0 with redis options {:url=>"redis://localhost:6379/0", :namespace=>"sidekiq"}
``` ```
......
...@@ -40,7 +40,7 @@ it](https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/6/htm ...@@ -40,7 +40,7 @@ it](https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/6/htm
We assume that you already have SSH certificates set up, and have We assume that you already have SSH certificates set up, and have
added the `TrustedUserCAKeys` of your CA to your `sshd_config`, e.g.: added the `TrustedUserCAKeys` of your CA to your `sshd_config`, e.g.:
``` ```plaintext
TrustedUserCAKeys /etc/security/mycompany_user_ca.pub TrustedUserCAKeys /etc/security/mycompany_user_ca.pub
``` ```
...@@ -87,7 +87,7 @@ Then, in your `sshd_config` set up `AuthorizedPrincipalsCommand` for ...@@ -87,7 +87,7 @@ Then, in your `sshd_config` set up `AuthorizedPrincipalsCommand` for
the `git` user. Hopefully you can use the default one shipped with the `git` user. Hopefully you can use the default one shipped with
GitLab: GitLab:
``` ```plaintext
Match User git Match User git
AuthorizedPrincipalsCommandUser root AuthorizedPrincipalsCommandUser root
AuthorizedPrincipalsCommand /opt/gitlab/embedded/service/gitlab-shell/bin/gitlab-shell-authorized-principals-check %i sshUsers AuthorizedPrincipalsCommand /opt/gitlab/embedded/service/gitlab-shell/bin/gitlab-shell-authorized-principals-check %i sshUsers
...@@ -95,7 +95,7 @@ Match User git ...@@ -95,7 +95,7 @@ Match User git
This command will emit output that looks something like: This command will emit output that looks something like:
``` ```shell
command="/opt/gitlab/embedded/service/gitlab-shell/bin/gitlab-shell username-{KEY_ID}",no-port-forwarding,no-X11-forwarding,no-agent-forwarding,no-pty {PRINCIPAL} command="/opt/gitlab/embedded/service/gitlab-shell/bin/gitlab-shell username-{KEY_ID}",no-port-forwarding,no-X11-forwarding,no-agent-forwarding,no-pty {PRINCIPAL}
``` ```
...@@ -108,7 +108,7 @@ some principal that's guaranteed to be part of the key for all users ...@@ -108,7 +108,7 @@ some principal that's guaranteed to be part of the key for all users
who can log in to GitLab, or you must provide a list of principals, who can log in to GitLab, or you must provide a list of principals,
one of which is going to be present for the user, e.g.: one of which is going to be present for the user, e.g.:
``` ```plaintext
[...] [...]
AuthorizedPrincipalsCommand /opt/gitlab/embedded/service/gitlab-shell/bin/gitlab-shell-authorized-principals-check %i sshUsers windowsUsers AuthorizedPrincipalsCommand /opt/gitlab/embedded/service/gitlab-shell/bin/gitlab-shell-authorized-principals-check %i sshUsers windowsUsers
``` ```
......
...@@ -73,7 +73,7 @@ The instructions make the assumption that you will be using the email address `i ...@@ -73,7 +73,7 @@ The instructions make the assumption that you will be using the email address `i
1. Send the new `incoming` user a dummy email to test SMTP, by entering the following into the SMTP prompt: 1. Send the new `incoming` user a dummy email to test SMTP, by entering the following into the SMTP prompt:
``` ```plaintext
ehlo localhost ehlo localhost
mail from: root@localhost mail from: root@localhost
rcpt to: incoming@localhost rcpt to: incoming@localhost
...@@ -101,7 +101,7 @@ The instructions make the assumption that you will be using the email address `i ...@@ -101,7 +101,7 @@ The instructions make the assumption that you will be using the email address `i
You should see output like this: You should see output like this:
``` ```plaintext
"/var/mail/incoming": 1 message 1 unread "/var/mail/incoming": 1 message 1 unread
>U 1 root@localhost 59/2842 Re: Some issue >U 1 root@localhost 59/2842 Re: Some issue
``` ```
...@@ -147,7 +147,7 @@ Courier, which we will install later to add IMAP authentication, requires mailbo ...@@ -147,7 +147,7 @@ Courier, which we will install later to add IMAP authentication, requires mailbo
You should see output like this: You should see output like this:
``` ```plaintext
"/home/incoming/Maildir": 1 message 1 unread "/home/incoming/Maildir": 1 message 1 unread
>U 1 root@localhost 59/2842 Re: Some issue >U 1 root@localhost 59/2842 Re: Some issue
``` ```
...@@ -253,7 +253,7 @@ Courier, which we will install later to add IMAP authentication, requires mailbo ...@@ -253,7 +253,7 @@ Courier, which we will install later to add IMAP authentication, requires mailbo
1. Send the `incoming` user a dummy email to test SMTP, by entering the following into the SMTP prompt: 1. Send the `incoming` user a dummy email to test SMTP, by entering the following into the SMTP prompt:
``` ```plaintext
ehlo gitlab.example.com ehlo gitlab.example.com
mail from: root@gitlab.example.com mail from: root@gitlab.example.com
rcpt to: incoming@gitlab.example.com rcpt to: incoming@gitlab.example.com
...@@ -277,7 +277,7 @@ Courier, which we will install later to add IMAP authentication, requires mailbo ...@@ -277,7 +277,7 @@ Courier, which we will install later to add IMAP authentication, requires mailbo
You should see output like this: You should see output like this:
``` ```plaintext
"/home/incoming/Maildir": 1 message 1 unread "/home/incoming/Maildir": 1 message 1 unread
>U 1 root@gitlab.example.com 59/2842 Re: Some issue >U 1 root@gitlab.example.com 59/2842 Re: Some issue
``` ```
...@@ -313,7 +313,7 @@ Courier, which we will install later to add IMAP authentication, requires mailbo ...@@ -313,7 +313,7 @@ Courier, which we will install later to add IMAP authentication, requires mailbo
1. Sign in as the `incoming` user to test IMAP, by entering the following into the IMAP prompt: 1. Sign in as the `incoming` user to test IMAP, by entering the following into the IMAP prompt:
``` ```plaintext
a login incoming PASSWORD a login incoming PASSWORD
``` ```
...@@ -321,7 +321,7 @@ Courier, which we will install later to add IMAP authentication, requires mailbo ...@@ -321,7 +321,7 @@ Courier, which we will install later to add IMAP authentication, requires mailbo
You should see output like this: You should see output like this:
``` ```plaintext
a OK LOGIN Ok. a OK LOGIN Ok.
``` ```
......
...@@ -15,7 +15,7 @@ storage shards) to distribute the storage load between several mount points. ...@@ -15,7 +15,7 @@ storage shards) to distribute the storage load between several mount points.
Example: this is OK: Example: this is OK:
``` ```plaintext
default: default:
path: /mnt/git-storage-1 path: /mnt/git-storage-1
storage2: storage2:
...@@ -24,7 +24,7 @@ storage2: ...@@ -24,7 +24,7 @@ storage2:
This is not OK because it nests storage paths: This is not OK because it nests storage paths:
``` ```plaintext
default: default:
path: /mnt/git-storage-1 path: /mnt/git-storage-1
storage2: storage2:
......
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