Merge branch 'docs-lint-rule-md004' into 'master'

Docs: Enforce consistent prefix for bullet lists

See merge request gitlab-org/gitlab-ce!30206

.gitlab/ci/docs.gitlab-ci.yml

@@ -69,7 +69,7 @@ docs lint:
     # Lint Markdown
     # https://github.com/markdownlint/markdownlint/blob/master/docs/RULES.md
     - bundle exec mdl content/$DOCS_GITLAB_REPO_SUFFIX/**/*.md --rules \
-        MD032
+        MD004,MD032
     # Build HTML from Markdown
     - bundle exec nanoc
     # Check the internal links

doc/administration/database_load_balancing.md

@@ -40,16 +40,16 @@ For example, say you have a primary (`db1.gitlab.com`) and two secondaries,
 `db2.gitlab.com` and `db3.gitlab.com`. For this setup you will need to have 3
 load balancers, one for every host. For example:
 
-* `primary.gitlab.com` forwards to `db1.gitlab.com`
-* `secondary1.gitlab.com` forwards to `db2.gitlab.com`
-* `secondary2.gitlab.com` forwards to `db3.gitlab.com`
+- `primary.gitlab.com` forwards to `db1.gitlab.com`
+- `secondary1.gitlab.com` forwards to `db2.gitlab.com`
+- `secondary2.gitlab.com` forwards to `db3.gitlab.com`
 
 Now let's say that a failover happens and db2 becomes the new primary. This
 means forwarding should now happen as follows:
 
-* `primary.gitlab.com` forwards to `db2.gitlab.com`
-* `secondary1.gitlab.com` forwards to `db1.gitlab.com`
-* `secondary2.gitlab.com` forwards to `db3.gitlab.com`
+- `primary.gitlab.com` forwards to `db2.gitlab.com`
+- `secondary1.gitlab.com` forwards to `db1.gitlab.com`
+- `secondary2.gitlab.com` forwards to `db3.gitlab.com`
 
 GitLab does not take care of this for you, so you will need to do so yourself.
 
@@ -209,9 +209,9 @@ without it immediately leading to errors being presented to the users.
 
 The load balancer logs various messages, such as:
 
-* When a host is marked as offline
-* When a host comes back online
-* When all secondaries are offline
+- When a host is marked as offline
+- When a host comes back online
+- When all secondaries are offline
 
 Each log message contains the tag `[DB-LB]` to make searching/filtering of such
 log entries easier. For example:

doc/administration/geo/replication/high_availability.md

@@ -79,9 +79,9 @@ The **primary** database will require modification later, as part of
 A **secondary** cluster is similar to any other GitLab HA cluster, with two
 major differences:
 
-* The main PostgreSQL database is a read-only replica of the **primary** node's
+- The main PostgreSQL database is a read-only replica of the **primary** node's
   PostgreSQL database.
-* There is also a single PostgreSQL database for the **secondary** cluster,
+- There is also a single PostgreSQL database for the **secondary** cluster,
   called the "tracking database", which tracks the synchronization state of
   various resources.
 
@@ -93,9 +93,9 @@ from the normal HA setup.
 Configure the following services, again using the non-Geo high availability
 documentation:
 
-* [Configuring Redis for GitLab HA](../../high_availability/redis.md) for high
+- [Configuring Redis for GitLab HA](../../high_availability/redis.md) for high
   availability.
-* [NFS](../../high_availability/nfs.md) which will store data that is
+- [NFS](../../high_availability/nfs.md) which will store data that is
   synchronized from the **primary** node.
 
 ### Step 2: Configure the main read-only replica PostgreSQL database on the **secondary** node
@@ -270,15 +270,15 @@ After making these changes [Reconfigure GitLab][gitlab-reconfigure] so the chang
 
 On the secondary the following GitLab frontend services will be enabled:
 
-* geo-logcursor
-* gitlab-pages
-* gitlab-workhorse
-* logrotate
-* nginx
-* registry
-* remote-syslog
-* sidekiq
-* unicorn
+- geo-logcursor
+- gitlab-pages
+- gitlab-workhorse
+- logrotate
+- nginx
+- registry
+- remote-syslog
+- sidekiq
+- unicorn
 
 Verify these services by running `sudo gitlab-ctl status` on the frontend
 application servers.

doc/development/architecture.md

@@ -116,10 +116,10 @@ graph TB
 
 ### Component legend
 
-* ✅ - Installed by default
-* ⚙ - Requires additional configuration, or GitLab Managed Apps
-* ⤓ - Manual installation required
-* ❌ - Not supported or no instructions available
+- ✅ - Installed by default
+- ⚙ - Requires additional configuration, or GitLab Managed Apps
+- ⤓ - Manual installation required
+- ❌ - Not supported or no instructions available
 
 Component statuses are linked to configuration documentation for each component.
 

doc/development/contributing/issue_workflow.md

@@ -192,20 +192,20 @@ There can be multiple facets of the impact. The below is a guideline.
 
 If a bug seems to fall between two severity labels, assign it to the higher-severity label.
 
-* Example(s) of ~S1
-  * Data corruption/loss. 
-  * Security breach.
-  * Unable to create an issue or merge request. 
-  * Unable to add a comment or discussion to the issue or merge request.
-* Example(s) of ~S2
-  * Cannot submit changes through the web IDE but the commandline works.
-  * A status widget on the merge request page is not working but information can be seen in the test pipeline page.
-* Example(s) of ~S3
-  * Can create merge requests only from the Merge Requests list view, not from an Issue page.
-  * Status is not updated in real time and needs a page refresh.
-* Example(s) of ~S4
-  * Label colors are incorrect.
-  * UI elements are not fully aligned.
+- Example(s) of ~S1
+  - Data corruption/loss. 
+  - Security breach.
+  - Unable to create an issue or merge request. 
+  - Unable to add a comment or discussion to the issue or merge request.
+- Example(s) of ~S2
+  - Cannot submit changes through the web IDE but the commandline works.
+  - A status widget on the merge request page is not working but information can be seen in the test pipeline page.
+- Example(s) of ~S3
+  - Can create merge requests only from the Merge Requests list view, not from an Issue page.
+  - Status is not updated in real time and needs a page refresh.
+- Example(s) of ~S4
+  - Label colors are incorrect.
+  - UI elements are not fully aligned.
   
 ## Label for community contributors
 

doc/development/documentation/styleguide.md

@@ -76,8 +76,8 @@ and cross-link between any related content.
 
 We employ a **docs-first methodology** to help ensure that the docs remain a complete and trusted resource, and to make communicating about the use of GitLab more efficient.
 
-* If the answer to a question exists in documentation, share the link to the docs instead of rephrasing the information.
-* When you encounter new information not available in GitLab’s documentation (for example, when working on a support case or testing a feature), your first step should be to create a merge request to add this information to the docs. You can then share the MR in order to communicate this information.
+- If the answer to a question exists in documentation, share the link to the docs instead of rephrasing the information.
+- When you encounter new information not available in GitLab’s documentation (for example, when working on a support case or testing a feature), your first step should be to create a merge request to add this information to the docs. You can then share the MR in order to communicate this information.
 
 New information that would be useful toward the future usage or troubleshooting of GitLab should not be written directly in a forum or other messaging system, but added to a docs MR and then referenced, as described above. Note that among any other doc changes, you can always add a Troubleshooting section to a doc if none exists, or un-comment and use the placeholder Troubleshooting section included as part of our [doc template](structure.md#template-for-new-docs), if present.
 

doc/development/ee_features.md

@@ -959,10 +959,10 @@ import mixin from 'ee_else_ce/path/mixin';
 
 #### `template` tag
 
-* **EE Child components**
+- **EE Child components**
   - Since we are using the async loading to check which component to load, we'd still use the component's name, check [this example](#child-component-only-used-in-ee).
 
-* **EE extra HTML**
+- **EE extra HTML**
   - For the templates that have extra HTML in EE we should move it into a new component and use the `ee_else_ce` dynamic import
 
 ### Non Vue Files

doc/development/gitaly.md

@@ -88,12 +88,12 @@ Until GitLab has eliminated most of these inefficiencies or the use of
 NFS is discontinued for Git data, Rugged implementations of some of the
 most commonly-used RPCs can be enabled via feature flags:
 
-* `rugged_find_commit`
-* `rugged_get_tree_entries`
-* `rugged_tree_entry`
-* `rugged_commit_is_ancestor`
-* `rugged_commit_tree_entry`
-* `rugged_list_commits_by_oid`
+- `rugged_find_commit`
+- `rugged_get_tree_entries`
+- `rugged_tree_entry`
+- `rugged_commit_is_ancestor`
+- `rugged_commit_tree_entry`
+- `rugged_list_commits_by_oid`
 
 A convenience Rake task can be used to enable or disable these flags
 all together. To enable:

doc/development/testing_guide/review_apps.md

@@ -257,7 +257,7 @@ find a way to limit it to only us.**
 
 ## Other resources
 
-* [Review Apps integration for CE/EE (presentation)](https://docs.google.com/presentation/d/1QPLr6FO4LduROU8pQIPkX1yfGvD13GEJIBOenqoKxR8/edit?usp=sharing)
+- [Review Apps integration for CE/EE (presentation)](https://docs.google.com/presentation/d/1QPLr6FO4LduROU8pQIPkX1yfGvD13GEJIBOenqoKxR8/edit?usp=sharing)
 
 [charts-1068]: https://gitlab.com/charts/gitlab/issues/1068
 [gitlab-pipeline]: https://gitlab.com/gitlab-org/gitlab-ce/pipelines/44362587

doc/install/openshift_and_gitlab/index.md

@@ -145,12 +145,12 @@ Login successful.
 
 You have access to the following projects and can switch between them with 'oc project <projectname>':
 
-  * cockpit
-  * default (current)
-  * delete
-  * openshift
-  * openshift-infra
-  * sample
+- cockpit
+- default (current)
+- delete
+- openshift
+- openshift-infra
+- sample
 
 Using project "default".
 ```

doc/integration/jenkins_deprecated.md

@@ -8,13 +8,13 @@ Please use documentation for the new [Jenkins CI service](jenkins.md).
 
 Integration includes:
 
-* Trigger Jenkins build after push to repo
-* Show build status on Merge Request page
+- Trigger Jenkins build after push to repo
+- Show build status on Merge Request page
 
 Requirements:
 
-* [Jenkins GitLab Hook plugin](https://wiki.jenkins.io/display/JENKINS/GitLab+Hook+Plugin)
-* git clone access for Jenkins from GitLab repo (via ssh key)
+- [Jenkins GitLab Hook plugin](https://wiki.jenkins.io/display/JENKINS/GitLab+Hook+Plugin)
+- git clone access for Jenkins from GitLab repo (via ssh key)
 
 ## Jenkins
 

doc/raketasks/web_hooks.md

@@ -2,42 +2,54 @@
 
 ## Add a webhook for **ALL** projects:
 
+```sh
     # omnibus-gitlab
     sudo gitlab-rake gitlab:web_hook:add URL="http://example.com/hook"
     # source installations
     bundle exec rake gitlab:web_hook:add URL="http://example.com/hook" RAILS_ENV=production
+```
 
 ## Add a webhook for projects in a given **NAMESPACE**:
 
+```sh
     # omnibus-gitlab
     sudo gitlab-rake gitlab:web_hook:add URL="http://example.com/hook" NAMESPACE=acme
     # source installations
     bundle exec rake gitlab:web_hook:add URL="http://example.com/hook" NAMESPACE=acme RAILS_ENV=production
+```
 
 ## Remove a webhook from **ALL** projects using:
 
+```sh
     # omnibus-gitlab
     sudo gitlab-rake gitlab:web_hook:rm URL="http://example.com/hook"
     # source installations
     bundle exec rake gitlab:web_hook:rm URL="http://example.com/hook" RAILS_ENV=production
+```
 
 ## Remove a webhook from projects in a given **NAMESPACE**:
 
+```sh
     # omnibus-gitlab
     sudo gitlab-rake gitlab:web_hook:rm URL="http://example.com/hook" NAMESPACE=acme
     # source installations
     bundle exec rake gitlab:web_hook:rm URL="http://example.com/hook" NAMESPACE=acme RAILS_ENV=production
+```
 
 ## List **ALL** webhooks:
 
+```sh
     # omnibus-gitlab
     sudo gitlab-rake gitlab:web_hook:list
     # source installations
     bundle exec rake gitlab:web_hook:list RAILS_ENV=production
+```
 
 ## List the webhooks from projects in a given **NAMESPACE**:
 
-    # omnibus-gitlab
-    sudo gitlab-rake gitlab:web_hook:list NAMESPACE=acme
-    # source installations
-    bundle exec rake gitlab:web_hook:list NAMESPACE=acme RAILS_ENV=production
+```sh
+  # omnibus-gitlab
+  sudo gitlab-rake gitlab:web_hook:list NAMESPACE=acme
+  # source installations
+  bundle exec rake gitlab:web_hook:list NAMESPACE=acme RAILS_ENV=production
+```
\ No newline at end of file

doc/update/upgrading_from_ce_to_ee.md

@@ -25,14 +25,14 @@ Branch names use the format `major-minor-stable-ee` for Enterprise Edition, and
 `major-minor-stable` for Community Edition. For example, for 11.8.0 you would
 use the following branches:
 
-* Enterprise Edition: `11-8-stable-ee`
-* Community Edition: `11-8-stable`
+- Enterprise Edition: `11-8-stable-ee`
+- Community Edition: `11-8-stable`
 
 ### 0. Backup
 
 Make a backup just in case something goes wrong:
 
-```bash
+```sh
 cd /home/git/gitlab
 sudo -u git -H bundle exec rake gitlab:backup:create RAILS_ENV=production
 ```
@@ -42,13 +42,13 @@ privileges to the GitLab user on the database version.
 
 ### 1. Stop server
 
-```bash
+```sh
 sudo service gitlab stop
 ```
 
 ### 2. Get the EE code
 
-```bash
+```sh
 cd /home/git/gitlab
 sudo -u git -H git remote add -f ee https://gitlab.com/gitlab-org/gitlab-ee.git
 sudo -u git -H git checkout EE_BRANCH
@@ -56,7 +56,7 @@ sudo -u git -H git checkout EE_BRANCH
 
 ### 3. Install libs, migrations, etc.
 
-```bash
+```sh
 cd /home/git/gitlab
 
 # MySQL installations (note: the line below states '--without postgres')
@@ -80,7 +80,7 @@ document linked above and enable the indexer usage in the GitLab admin settings.
 
 ### 5. Start application
 
-```bash
+```sh
 sudo service gitlab start
 sudo service nginx restart
 ```
@@ -89,13 +89,13 @@ sudo service nginx restart
 
 Check if GitLab and its environment are configured correctly:
 
-```bash
+```sh
 sudo -u git -H bundle exec rake gitlab:env:info RAILS_ENV=production
 ```
 
 To make sure you didn't miss anything run a more thorough check with:
 
-```bash
+```sh
 sudo -u git -H bundle exec rake gitlab:check RAILS_ENV=production
 ```
 
@@ -105,14 +105,14 @@ If all items are green, then congratulations upgrade complete!
 
 ### 1. Revert the code to the previous version
 
-```bash
+```sh
 cd /home/git/gitlab
 sudo -u git -H git checkout CE_BRANCH
 ```
 
 ### 2. Restore from the backup
 
-```bash
+```sh
 cd /home/git/gitlab
 sudo -u git -H bundle exec rake gitlab:backup:restore RAILS_ENV=production
 ```

doc/user/group/contribution_analytics/index.md

@@ -54,13 +54,13 @@ Select the desired period from the calendar dropdown.
 
 Contributions per group member are also presented in tabular format. Click a column header to sort the table by that column:
 
-* Member name
-* Number of pushed events
-* Number of opened issues
-* Number of closed issues
-* Number of opened MRs
-* Number of accepted MRs
-* Number of total contributions
+- Member name
+- Number of pushed events
+- Number of opened issues
+- Number of closed issues
+- Number of opened MRs
+- Number of accepted MRs
+- Number of total contributions
 
 ![Contribution analytics contributions table](img/group_stats_table.png)
 

doc/user/markdown.md

@@ -1115,20 +1115,20 @@ will point the link to `wikis/style` only when the link is inside of a wiki mark
 GFM will autolink almost any URL you put into your text:
 
 ```markdown
-* https://www.google.com
-* https://google.com/
-* ftp://ftp.us.debian.org/debian/
-* smb://foo/bar/baz
-* irc://irc.freenode.net/gitlab
-* http://localhost:3000
+- https://www.google.com
+- https://google.com/
+- ftp://ftp.us.debian.org/debian/
+- smb://foo/bar/baz
+- irc://irc.freenode.net/gitlab
+- http://localhost:3000
 ```
 
-* https://www.google.com
-* https://google.com/
-* ftp://ftp.us.debian.org/debian/
-* smb://foo/bar/baz
-* irc://irc.freenode.net/gitlab
-* http://localhost:3000
+- https://www.google.com
+- https://google.com/
+- ftp://ftp.us.debian.org/debian/
+- smb://foo/bar/baz
+- irc://irc.freenode.net/gitlab
+- http://localhost:3000
 
 ### Lists
 
@@ -1147,7 +1147,7 @@ Examples:
 ```md
 1. First ordered list item
 2. Another item
-   * Unordered sub-list.
+   - Unordered sub-list.
 1. Actual numbers don't matter, just that it's a number
    1. Ordered sub-list
    1. Next ordered sub-list item
@@ -1160,7 +1160,7 @@ Examples:
 
 1. First ordered list item
 2. Another item
-   * Unordered sub-list.
+   - Unordered sub-list.
 1. Actual numbers don't matter, just that it's a number
    1. Ordered sub-list
    1. Next ordered sub-list item