From 46336044240b7695af905acc8bf07a8629976952 Mon Sep 17 00:00:00 2001
From: Marcel Amirault <mamirault@gitlab.com>
Date: Wed, 10 Jul 2019 18:23:55 +0000
Subject: Fix whitespace in many administration docs

Many code blocks are 4spaced, and they render in GitLab
without coloring as a result, even though they are
fenced with a language label. If in a list, other items
will render as being in a code block too, even if not
meant to. This fixes all these issues for many admin
docs (part 2)
---
 doc/administration/pages/source.md | 248 ++++++++++++++++++-------------------
 1 file changed, 124 insertions(+), 124 deletions(-)

(limited to 'doc/administration/pages/source.md')

diff --git a/doc/administration/pages/source.md b/doc/administration/pages/source.md
index 2100f7cd707..b2cad6cf926 100644
--- a/doc/administration/pages/source.md
+++ b/doc/administration/pages/source.md
@@ -102,50 +102,50 @@ The Pages daemon doesn't listen to the outside world.
 
 1. Install the Pages daemon:
 
-    ```
-    cd /home/git
-    sudo -u git -H git clone https://gitlab.com/gitlab-org/gitlab-pages.git
-    cd gitlab-pages
-    sudo -u git -H git checkout v$(</home/git/gitlab/GITLAB_PAGES_VERSION)
-    sudo -u git -H make
-    ```
+   ```
+   cd /home/git
+   sudo -u git -H git clone https://gitlab.com/gitlab-org/gitlab-pages.git
+   cd gitlab-pages
+   sudo -u git -H git checkout v$(</home/git/gitlab/GITLAB_PAGES_VERSION)
+   sudo -u git -H make
+   ```
 
 1. Go to the GitLab installation directory:
 
-    ```bash
-    cd /home/git/gitlab
-    ```
+   ```bash
+   cd /home/git/gitlab
+   ```
 
 1. Edit `gitlab.yml` and under the `pages` setting, set `enabled` to `true` and
    the `host` to the FQDN under which GitLab Pages will be served:
 
-    ```yaml
-    ## GitLab Pages
-    pages:
-      enabled: true
-      # The location where pages are stored (default: shared/pages).
-      # path: shared/pages
+   ```yaml
+   ## GitLab Pages
+   pages:
+     enabled: true
+     # The location where pages are stored (default: shared/pages).
+     # path: shared/pages
 
-      host: example.io
-      port: 80
-      https: false
-    ```
+     host: example.io
+     port: 80
+     https: false
+   ```
 
 1. Edit `/etc/default/gitlab` and set `gitlab_pages_enabled` to `true` in
    order to enable the pages daemon. In `gitlab_pages_options` the
    `-pages-domain` must match the `host` setting that you set above.
 
-    ```
-    gitlab_pages_enabled=true
-    gitlab_pages_options="-pages-domain example.io -pages-root $app_root/shared/pages -listen-proxy 127.0.0.1:8090"
-    ```
+   ```
+   gitlab_pages_enabled=true
+   gitlab_pages_options="-pages-domain example.io -pages-root $app_root/shared/pages -listen-proxy 127.0.0.1:8090"
+   ```
 
 1. Copy the `gitlab-pages` Nginx configuration file:
 
-    ```bash
-    sudo cp lib/support/nginx/gitlab-pages /etc/nginx/sites-available/gitlab-pages.conf
-    sudo ln -sf /etc/nginx/sites-{available,enabled}/gitlab-pages.conf
-    ```
+   ```bash
+   sudo cp lib/support/nginx/gitlab-pages /etc/nginx/sites-available/gitlab-pages.conf
+   sudo ln -sf /etc/nginx/sites-{available,enabled}/gitlab-pages.conf
+   ```
 
 1. Restart NGINX
 1. [Restart GitLab][restart]
@@ -165,27 +165,27 @@ outside world.
 
 1. Install the Pages daemon:
 
-    ```
-    cd /home/git
-    sudo -u git -H git clone https://gitlab.com/gitlab-org/gitlab-pages.git
-    cd gitlab-pages
-    sudo -u git -H git checkout v$(</home/git/gitlab/GITLAB_PAGES_VERSION)
-    sudo -u git -H make
-    ```
+   ```
+   cd /home/git
+   sudo -u git -H git clone https://gitlab.com/gitlab-org/gitlab-pages.git
+   cd gitlab-pages
+   sudo -u git -H git checkout v$(</home/git/gitlab/GITLAB_PAGES_VERSION)
+   sudo -u git -H make
+   ```
 
 1. In `gitlab.yml`, set the port to `443` and https to `true`:
 
-    ```bash
-    ## GitLab Pages
-    pages:
-      enabled: true
-      # The location where pages are stored (default: shared/pages).
-      # path: shared/pages
+   ```bash
+   ## GitLab Pages
+   pages:
+     enabled: true
+     # The location where pages are stored (default: shared/pages).
+     # path: shared/pages
 
-      host: example.io
-      port: 443
-      https: true
-    ```
+     host: example.io
+     port: 443
+     https: true
+   ```
 
 1. Edit `/etc/default/gitlab` and set `gitlab_pages_enabled` to `true` in
    order to enable the pages daemon. In `gitlab_pages_options` the
@@ -193,17 +193,17 @@ outside world.
    The `-root-cert` and `-root-key` settings are the wildcard TLS certificates
    of the `example.io` domain:
 
-    ```
-    gitlab_pages_enabled=true
-    gitlab_pages_options="-pages-domain example.io -pages-root $app_root/shared/pages -listen-proxy 127.0.0.1:8090 -root-cert /path/to/example.io.crt -root-key /path/to/example.io.key
-    ```
+   ```
+   gitlab_pages_enabled=true
+   gitlab_pages_options="-pages-domain example.io -pages-root $app_root/shared/pages -listen-proxy 127.0.0.1:8090 -root-cert /path/to/example.io.crt -root-key /path/to/example.io.key
+   ```
 
 1. Copy the `gitlab-pages-ssl` Nginx configuration file:
 
-    ```bash
-    sudo cp lib/support/nginx/gitlab-pages-ssl /etc/nginx/sites-available/gitlab-pages-ssl.conf
-    sudo ln -sf /etc/nginx/sites-{available,enabled}/gitlab-pages-ssl.conf
-    ```
+   ```bash
+   sudo cp lib/support/nginx/gitlab-pages-ssl /etc/nginx/sites-available/gitlab-pages-ssl.conf
+   sudo ln -sf /etc/nginx/sites-{available,enabled}/gitlab-pages-ssl.conf
+   ```
 
 1. Restart NGINX
 1. [Restart GitLab][restart]
@@ -231,48 +231,48 @@ world. Custom domains are supported, but no TLS.
 
 1. Install the Pages daemon:
 
-    ```
-    cd /home/git
-    sudo -u git -H git clone https://gitlab.com/gitlab-org/gitlab-pages.git
-    cd gitlab-pages
-    sudo -u git -H git checkout v$(</home/git/gitlab/GITLAB_PAGES_VERSION)
-    sudo -u git -H make
-    ```
+   ```
+   cd /home/git
+   sudo -u git -H git clone https://gitlab.com/gitlab-org/gitlab-pages.git
+   cd gitlab-pages
+   sudo -u git -H git checkout v$(</home/git/gitlab/GITLAB_PAGES_VERSION)
+   sudo -u git -H make
+   ```
 
 1. Edit `gitlab.yml` to look like the example below. You need to change the
    `host` to the FQDN under which GitLab Pages will be served. Set
    `external_http` to the secondary IP on which the pages daemon will listen
    for connections:
 
-    ```yaml
-    pages:
-      enabled: true
-      # The location where pages are stored (default: shared/pages).
-      # path: shared/pages
+   ```yaml
+   pages:
+     enabled: true
+     # The location where pages are stored (default: shared/pages).
+     # path: shared/pages
 
-      host: example.io
-      port: 80
-      https: false
+     host: example.io
+     port: 80
+     https: false
 
-      external_http: 192.0.2.2:80
-    ```
+     external_http: 192.0.2.2:80
+   ```
 
 1. Edit `/etc/default/gitlab` and set `gitlab_pages_enabled` to `true` in
    order to enable the pages daemon. In `gitlab_pages_options` the
    `-pages-domain` and `-listen-http` must match the `host` and `external_http`
    settings that you set above respectively:
 
-    ```
-    gitlab_pages_enabled=true
-    gitlab_pages_options="-pages-domain example.io -pages-root $app_root/shared/pages -listen-proxy 127.0.0.1:8090 -listen-http 192.0.2.2:80"
-    ```
+   ```
+   gitlab_pages_enabled=true
+   gitlab_pages_options="-pages-domain example.io -pages-root $app_root/shared/pages -listen-proxy 127.0.0.1:8090 -listen-http 192.0.2.2:80"
+   ```
 
 1. Copy the `gitlab-pages-ssl` Nginx configuration file:
 
-    ```bash
-    sudo cp lib/support/nginx/gitlab-pages /etc/nginx/sites-available/gitlab-pages.conf
-    sudo ln -sf /etc/nginx/sites-{available,enabled}/gitlab-pages.conf
-    ```
+   ```bash
+   sudo cp lib/support/nginx/gitlab-pages /etc/nginx/sites-available/gitlab-pages.conf
+   sudo ln -sf /etc/nginx/sites-{available,enabled}/gitlab-pages.conf
+   ```
 
 1. Edit all GitLab related configs in `/etc/nginx/site-available/` and replace
    `0.0.0.0` with `192.0.2.1`, where `192.0.2.1` the primary IP where GitLab
@@ -297,33 +297,33 @@ world. Custom domains and TLS are supported.
 
 1. Install the Pages daemon:
 
-    ```
-    cd /home/git
-    sudo -u git -H git clone https://gitlab.com/gitlab-org/gitlab-pages.git
-    cd gitlab-pages
-    sudo -u git -H git checkout v$(</home/git/gitlab/GITLAB_PAGES_VERSION)
-    sudo -u git -H make
-    ```
+   ```
+   cd /home/git
+   sudo -u git -H git clone https://gitlab.com/gitlab-org/gitlab-pages.git
+   cd gitlab-pages
+   sudo -u git -H git checkout v$(</home/git/gitlab/GITLAB_PAGES_VERSION)
+   sudo -u git -H make
+   ```
 
 1. Edit `gitlab.yml` to look like the example below. You need to change the
    `host` to the FQDN under which GitLab Pages will be served. Set
    `external_http` and `external_https` to the secondary IP on which the pages
    daemon will listen for connections:
 
-    ```yaml
-    ## GitLab Pages
-    pages:
-      enabled: true
-      # The location where pages are stored (default: shared/pages).
-      # path: shared/pages
+   ```yaml
+   ## GitLab Pages
+   pages:
+     enabled: true
+     # The location where pages are stored (default: shared/pages).
+     # path: shared/pages
 
-      host: example.io
-      port: 443
-      https: true
+     host: example.io
+     port: 443
+     https: true
 
-      external_http: 192.0.2.2:80
-      external_https: 192.0.2.2:443
-    ```
+     external_http: 192.0.2.2:80
+     external_https: 192.0.2.2:443
+   ```
 
 1. Edit `/etc/default/gitlab` and set `gitlab_pages_enabled` to `true` in
    order to enable the pages daemon. In `gitlab_pages_options` the
@@ -332,17 +332,17 @@ world. Custom domains and TLS are supported.
    The `-root-cert` and `-root-key` settings are the wildcard TLS certificates
    of the `example.io` domain:
 
-    ```
-    gitlab_pages_enabled=true
-    gitlab_pages_options="-pages-domain example.io -pages-root $app_root/shared/pages -listen-proxy 127.0.0.1:8090 -listen-http 192.0.2.2:80 -listen-https 192.0.2.2:443 -root-cert /path/to/example.io.crt -root-key /path/to/example.io.key
-    ```
+   ```
+   gitlab_pages_enabled=true
+   gitlab_pages_options="-pages-domain example.io -pages-root $app_root/shared/pages -listen-proxy 127.0.0.1:8090 -listen-http 192.0.2.2:80 -listen-https 192.0.2.2:443 -root-cert /path/to/example.io.crt -root-key /path/to/example.io.key
+   ```
 
 1. Copy the `gitlab-pages-ssl` Nginx configuration file:
 
-    ```bash
-    sudo cp lib/support/nginx/gitlab-pages-ssl /etc/nginx/sites-available/gitlab-pages-ssl.conf
-    sudo ln -sf /etc/nginx/sites-{available,enabled}/gitlab-pages-ssl.conf
-    ```
+   ```bash
+   sudo cp lib/support/nginx/gitlab-pages-ssl /etc/nginx/sites-available/gitlab-pages-ssl.conf
+   sudo ln -sf /etc/nginx/sites-{available,enabled}/gitlab-pages-ssl.conf
+   ```
 
 1. Edit all GitLab related configs in `/etc/nginx/site-available/` and replace
    `0.0.0.0` with `192.0.2.1`, where `192.0.2.1` the primary IP where GitLab
@@ -359,9 +359,9 @@ are stored.
    If you wish to store them in another location you must set it up in
    `/etc/gitlab/gitlab.rb`:
 
-    ```ruby
-    gitlab_rails['pages_path'] = "/mnt/storage/pages"
-    ```
+   ```ruby
+   gitlab_rails['pages_path'] = "/mnt/storage/pages"
+   ```
 
 1. [Reconfigure GitLab][reconfigure]
 
@@ -414,10 +414,10 @@ Pages access control is disabled by default. To enable it:
 
 1. Modify your `config/gitlab.yml` file:
 
-    ```yaml
-    pages:
-      access_control: true
-    ```
+   ```yaml
+   pages:
+     access_control: true
+   ```
 
 1. [Restart GitLab][restart].
 1. Create a new [system OAuth application](../../integration/oauth_provider.md#adding-an-application-through-the-profile).
@@ -426,12 +426,12 @@ Pages access control is disabled by default. To enable it:
    application, but it does need the "api" scope.
 1. Start the Pages daemon with the following additional arguments:
 
-    ```shell
-      -auth-client-secret <OAuth code generated by GitLab> \
-      -auth-redirect-uri http://projects.example.io/auth \
-      -auth-secret <40 random hex characters> \
-      -auth-server <URL of the GitLab instance>
-    ```
+   ```shell
+     -auth-client-secret <OAuth code generated by GitLab> \
+     -auth-redirect-uri http://projects.example.io/auth \
+     -auth-secret <40 random hex characters> \
+     -auth-server <URL of the GitLab instance>
+   ```
 
 1. Users can now configure it in their [projects' settings](../../user/project/pages/introduction.md#gitlab-pages-access-control-core-only).
 
@@ -444,12 +444,12 @@ are stored.
    If you wish to store them in another location you must set it up in
    `gitlab.yml` under the `pages` section:
 
-    ```yaml
-    pages:
-      enabled: true
-      # The location where pages are stored (default: shared/pages).
-      path: /mnt/storage/pages
-    ```
+   ```yaml
+   pages:
+     enabled: true
+     # The location where pages are stored (default: shared/pages).
+     path: /mnt/storage/pages
+   ```
 
 1. [Restart GitLab][restart]
 
-- 
cgit v1.2.1


From 60dfca155c205a0fad1cac367f7225100cb555eb Mon Sep 17 00:00:00 2001
From: Marcel Amirault <mamirault@gitlab.com>
Date: Mon, 12 Aug 2019 04:23:01 +0000
Subject: Add more rules to markdown lint check

Adds MD010 (Hard tabs), MD012 (blank lines), MD029 (ordered
list prefix), MD030 (spaces after list markers), and fixes
remaining docs that were failing these tests
---
 doc/administration/pages/source.md | 45 ++++++++++++++++----------------------
 1 file changed, 19 insertions(+), 26 deletions(-)

(limited to 'doc/administration/pages/source.md')

diff --git a/doc/administration/pages/source.md b/doc/administration/pages/source.md
index b2cad6cf926..c77a1a9638f 100644
--- a/doc/administration/pages/source.md
+++ b/doc/administration/pages/source.md
@@ -24,8 +24,6 @@ SNI and exposes pages using HTTP2 by default.
 You are encouraged to read its [README][pages-readme] to fully understand how
 it works.
 
----
-
 In the case of [custom domains](#custom-domains) (but not
 [wildcard domains](#wildcard-domains)), the Pages daemon needs to listen on
 ports `80` and/or `443`. For that reason, there is some flexibility in the way
@@ -92,8 +90,6 @@ since that is needed in all configurations.
 
 - [Wildcard DNS setup](#dns-configuration)
 
----
-
 URL scheme: `http://page.example.io`
 
 This is the minimum setup that you can use Pages with. It is the base for all
@@ -152,13 +148,12 @@ The Pages daemon doesn't listen to the outside world.
 
 ### Wildcard domains with TLS support
 
-> **Requirements:**
-> - [Wildcard DNS setup](#dns-configuration)
-> - Wildcard TLS certificate
->
-> ---
->
-> URL scheme: `https://page.example.io`
+**Requirements:**
+
+- [Wildcard DNS setup](#dns-configuration)
+- Wildcard TLS certificate
+
+URL scheme: `https://page.example.io`
 
 Nginx will proxy all requests to the daemon. Pages daemon doesn't listen to the
 outside world.
@@ -217,13 +212,12 @@ that without TLS certificates.
 
 ### Custom domains
 
-> **Requirements:**
-> - [Wildcard DNS setup](#dns-configuration)
-> - Secondary IP
->
-> ---
->
-> URL scheme: `http://page.example.io` and `http://domain.com`
+**Requirements:**
+
+- [Wildcard DNS setup](#dns-configuration)
+- Secondary IP
+
+URL scheme: `http://page.example.io` and `http://domain.com`
 
 In that case, the pages daemon is running, Nginx still proxies requests to
 the daemon but the daemon is also able to receive requests from the outside
@@ -282,14 +276,13 @@ world. Custom domains are supported, but no TLS.
 
 ### Custom domains with TLS support
 
-> **Requirements:**
-> - [Wildcard DNS setup](#dns-configuration)
-> - Wildcard TLS certificate
-> - Secondary IP
->
-> ---
->
-> URL scheme: `https://page.example.io` and `https://domain.com`
+**Requirements:**
+
+- [Wildcard DNS setup](#dns-configuration)
+- Wildcard TLS certificate
+- Secondary IP
+
+URL scheme: `https://page.example.io` and `https://domain.com`
 
 In that case, the pages daemon is running, Nginx still proxies requests to
 the daemon but the daemon is also able to receive requests from the outside
-- 
cgit v1.2.1