diff options
author | Marcel Amirault <mamirault@gitlab.com> | 2019-08-12 07:23:01 +0300 |
---|---|---|
committer | Evan Read <eread@gitlab.com> | 2019-08-12 07:23:01 +0300 |
commit | 60dfca155c205a0fad1cac367f7225100cb555eb (patch) | |
tree | b5b79fe61c48973e55e003a477cf8d4f2f9c4e80 /doc/user/project | |
parent | c3fddfc1285cad9a04a70405aede2f0952140115 (diff) |
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
Diffstat (limited to 'doc/user/project')
4 files changed, 16 insertions, 18 deletions
diff --git a/doc/user/project/integrations/jira_cloud_configuration.md b/doc/user/project/integrations/jira_cloud_configuration.md index 5a5ba2dd168..1d5a4a3d4c7 100644 --- a/doc/user/project/integrations/jira_cloud_configuration.md +++ b/doc/user/project/integrations/jira_cloud_configuration.md @@ -9,7 +9,7 @@ below to create one: It is important that the user associated with this email address has *write* access to projects in Jira. -2. Click **Create API token**. +1. Click **Create API token**. ![Jira API token](img/jira_api_token_menu.png) diff --git a/doc/user/project/merge_requests/merge_request_dependencies.md b/doc/user/project/merge_requests/merge_request_dependencies.md index 45cb56dfb6b..e046b3466c4 100644 --- a/doc/user/project/merge_requests/merge_request_dependencies.md +++ b/doc/user/project/merge_requests/merge_request_dependencies.md @@ -23,11 +23,11 @@ merge requests in the same project cannot depend on each other. ## Use cases -* Ensure changes to a library are merged before changes to a project that +- Ensure changes to a library are merged before changes to a project that imports the library -* Prevent a documentation-only merge request from being merged before the merge request +- Prevent a documentation-only merge request from being merged before the merge request implementing the feature to be documented -* Require an merge request updating a permissions matrix to be merged before merging an +- Require an merge request updating a permissions matrix to be merged before merging an merge request from someone who hasn't yet been granted permissions It is common for a single logical change to span several merge requests, spread @@ -97,9 +97,9 @@ merge. ## Limitations -* API support: [gitlab-ee#12551](https://gitlab.com/gitlab-org/gitlab-ee/issues/12551) -* Dependencies are not preserved across project export/import: [gitlab-ee#12549](https://gitlab.com/gitlab-org/gitlab-ee/issues/12549) -* Complex merge order dependencies are not supported: [gitlab-ee#11393](https://gitlab.com/gitlab-org/gitlab-ee/issues/11393) +- API support: [gitlab-ee#12551](https://gitlab.com/gitlab-org/gitlab-ee/issues/12551) +- Dependencies are not preserved across project export/import: [gitlab-ee#12549](https://gitlab.com/gitlab-org/gitlab-ee/issues/12549) +- Complex merge order dependencies are not supported: [gitlab-ee#11393](https://gitlab.com/gitlab-org/gitlab-ee/issues/11393) The last item merits a little more explanation. Dependencies between merge requests can be described as a graph of relationships. The simplest possible @@ -122,7 +122,6 @@ graph LR; Several different merge requests can also directly depend upon the same merge request: - ```mermaid graph LR; herfriend/another-lib!1-->myfriend/awesome-lib!10; diff --git a/doc/user/project/pages/custom_domains_ssl_tls_certification/index.md b/doc/user/project/pages/custom_domains_ssl_tls_certification/index.md index 6a9900d48f9..29f8e3fa0f7 100644 --- a/doc/user/project/pages/custom_domains_ssl_tls_certification/index.md +++ b/doc/user/project/pages/custom_domains_ssl_tls_certification/index.md @@ -192,13 +192,13 @@ can use the following setup: 1. In GitLab, verify your domain. 1. In Cloudflare, create a DNS `CNAME` record pointing `www` to `domain.com`. 1. In Cloudflare, add a Page Rule pointing `www.domain.com` to `domain.com`: - - Navigate to your domain's dashboard and click **Page Rules** - on the top nav. - - Click **Create Page Rule**. - - Enter the domain `www.domain.com` and click **+ Add a Setting**. - - From the dropdown menu, choose **Forwarding URL**, then select the - status code **301 - Permanent Redirect**. - - Enter the destination URL `https://domain.com`. + - Navigate to your domain's dashboard and click **Page Rules** + on the top nav. + - Click **Create Page Rule**. + - Enter the domain `www.domain.com` and click **+ Add a Setting**. + - From the dropdown menu, choose **Forwarding URL**, then select the + status code **301 - Permanent Redirect**. + - Enter the destination URL `https://domain.com`. ## Adding an SSL/TLS certificate to Pages @@ -263,7 +263,6 @@ To enable this setting: 1. Navigate to your project's **Settings > Pages**. 1. Tick the checkbox **Force HTTPS (requires valid certificates)**. - <!-- ## Troubleshooting Include any troubleshooting steps that you can foresee. If you know beforehand what issues diff --git a/doc/user/project/quick_actions.md b/doc/user/project/quick_actions.md index 437899dce1e..6758adf2b43 100644 --- a/doc/user/project/quick_actions.md +++ b/doc/user/project/quick_actions.md @@ -77,8 +77,8 @@ you manually enter a parameter, it must be enclosed in double quotation marks (`"`), unless it contains only: 1. ASCII letters. -2. Numerals. -3. Underscore, hyphen, question mark, dot, and ampersand. +1. Numerals. +1. Underscore, hyphen, question mark, dot, and ampersand. Parameters are also case-sensitive. Autocomplete handles this, and the insertion of quotation marks, automatically. |