diff options
author | GitLab Bot <gitlab-bot@gitlab.com> | 2020-02-06 15:09:11 +0000 |
---|---|---|
committer | GitLab Bot <gitlab-bot@gitlab.com> | 2020-02-06 15:09:11 +0000 |
commit | 0eb3d2f799ce4f4de87fb9fc6fd98e592323bc89 (patch) | |
tree | fd70d5bc63fe152e0a67aaa5a70e4c9f16dc6ffc /doc/development/documentation | |
parent | 5564275a0b378298dc6281599cbfe71a937109ff (diff) | |
download | gitlab-ce-0eb3d2f799ce4f4de87fb9fc6fd98e592323bc89.tar.gz |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc/development/documentation')
5 files changed, 23 insertions, 13 deletions
diff --git a/doc/development/documentation/site_architecture/global_nav.md b/doc/development/documentation/site_architecture/global_nav.md index 518850358ff..ae822e91360 100644 --- a/doc/development/documentation/site_architecture/global_nav.md +++ b/doc/development/documentation/site_architecture/global_nav.md @@ -4,9 +4,9 @@ description: "Learn how GitLab docs' global navigation works and how to add new # Global navigation -> - [Introduced](https://gitlab.com/gitlab-org/gitlab-docs/merge_requests/362) in GitLab 11.6. -> - [Updated](https://gitlab.com/gitlab-org/gitlab-docs/merge_requests/482) in GitLab 12.1. -> - [Per-project](https://gitlab.com/gitlab-org/gitlab-docs/merge_requests/498) navigation added in GitLab 12.2. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab-docs/-/merge_requests/362) in GitLab 11.6. +> - [Updated](https://gitlab.com/gitlab-org/gitlab-docs/-/merge_requests/482) in GitLab 12.1. +> - [Per-project](https://gitlab.com/gitlab-org/gitlab-docs/-/merge_requests/498) navigation added in GitLab 12.2. Global navigation (the left-most pane in our three pane documentation) provides: diff --git a/doc/development/documentation/site_architecture/release_process.md b/doc/development/documentation/site_architecture/release_process.md index de014c121a9..24608cc1a5e 100644 --- a/doc/development/documentation/site_architecture/release_process.md +++ b/doc/development/documentation/site_architecture/release_process.md @@ -176,7 +176,7 @@ versions: ./bin/rake release:dropdowns ``` -1. [Visit the merge requests page](https://gitlab.com/gitlab-org/gitlab-docs/merge_requests?label_name%5B%5D=release>) +1. [Visit the merge requests page](https://gitlab.com/gitlab-org/gitlab-docs/-/merge_requests?label_name%5B%5D=release) to check that their pipelines pass, and once all are merged, proceed to the following and final step. @@ -240,7 +240,7 @@ dropdown MRs are created have a caveat, and that is that the tests run by pulling the master branches of all products, instead of the respective stable ones. -In a real world scenario, the [Update 12.2 dropdown to match that of 12.4](https://gitlab.com/gitlab-org/gitlab-docs/merge_requests/604) +In a real world scenario, the [Update 12.2 dropdown to match that of 12.4](https://gitlab.com/gitlab-org/gitlab-docs/-/merge_requests/604) merge request failed because of the [`test_internal_links_and_anchors` test](https://gitlab.com/gitlab-org/gitlab-docs/-/jobs/328042431). This happened because there has been a rename of a product (`gitlab-monitor` to `gitlab-exporter`) diff --git a/doc/development/documentation/structure.md b/doc/development/documentation/structure.md index 21219dc100a..ac834ef1aac 100644 --- a/doc/development/documentation/structure.md +++ b/doc/development/documentation/structure.md @@ -127,7 +127,7 @@ Notes: ## Help and feedback section -The "help and feedback" section (introduced by [!319](https://gitlab.com/gitlab-org/gitlab-docs/merge_requests/319)) displayed at the end of each document +The "help and feedback" section (introduced by [!319](https://gitlab.com/gitlab-org/gitlab-docs/-/merge_requests/319)) displayed at the end of each document can be omitted from the doc by adding a key into the its frontmatter: ```yaml @@ -142,7 +142,7 @@ you must check with a technical writer before doing so. ### Disqus We also have integrated the docs site with Disqus (introduced by -[!151](https://gitlab.com/gitlab-org/gitlab-docs/merge_requests/151)), +[!151](https://gitlab.com/gitlab-org/gitlab-docs/-/merge_requests/151)), allowing our users to post comments. To omit only the comments from the feedback section, use the following diff --git a/doc/development/documentation/styleguide.md b/doc/development/documentation/styleguide.md index f979f882948..463b64c47af 100644 --- a/doc/development/documentation/styleguide.md +++ b/doc/development/documentation/styleguide.md @@ -175,7 +175,7 @@ The table below shows what kind of documentation goes where. | `doc/update/` | Contains instructions for updating GitLab. | | `doc/topics/` | Indexes per topic (`doc/topics/topic-name/index.md`): all resources for that topic. | -### Working with directories and files +### Work with directories and files 1. When you create a new directory, always start with an `index.md` file. Do not use another file name and **do not** create `README.md` files. @@ -530,6 +530,16 @@ For other punctuation rules, please refer to the document. For example, `## Examples` is a bad heading; `## GitLab Pages examples` is a better one. It's not an exact science, but please consider this carefully. +### Heading titles + +Keep heading titles clear and direct. Make every word count. To accommodate search engine optimization (SEO), use the imperative, where possible. + +| Do | Don't | +|:-----|:--------| +| Configure GDK | Configuring GDK | +| GitLab Release and Maintenance Policy | This section covers GitLab's Release and Maintenance Policy | +| Backport to older releases | Backporting to older releases | + ### Anchor links Headings generate anchor links automatically when rendered. `## This is an example` @@ -707,7 +717,7 @@ You can link any up-to-date video that is useful to the GitLab user. ### Embed videos -> [Introduced](https://gitlab.com/gitlab-org/gitlab-docs/merge_requests/472) in GitLab 12.1. +> [Introduced](https://gitlab.com/gitlab-org/gitlab-docs/-/merge_requests/472) in GitLab 12.1. The [GitLab Docs site](https://docs.gitlab.com) supports embedded videos. @@ -828,7 +838,7 @@ Usage examples: [Bootstrap utility class](https://getbootstrap.com/docs/4.4/utilities/float/): `**{tanuki, 32, float-right}**` renders as: **{tanuki, 32, float-right}** -### Using GitLab SVGs to describe UI elements +### Use GitLab SVGs to describe UI elements When using GitLab SVGs to describe screen elements, also include the name or tooltip of the element as text. @@ -1003,7 +1013,7 @@ Examples: - "Open a merge request to fix a broken link". - "After you open a merge request (MR), submit your MR for review and approval". -### Describing UI elements +### Describe UI elements The following are styles to follow when describing UI elements on a screen: @@ -1134,7 +1144,7 @@ GitLab.com Free, and all higher tiers. ### How it works -Introduced by [!244](https://gitlab.com/gitlab-org/gitlab-docs/merge_requests/244), +Introduced by [!244](https://gitlab.com/gitlab-org/gitlab-docs/-/merge_requests/244), the special markup `**(STARTER)**` will generate a `span` element to trigger the badges and tooltips (`<span class="badge-trigger starter">`). When the keyword "only" is added, the corresponding GitLab.com badge will not be displayed. diff --git a/doc/development/documentation/workflow.md b/doc/development/documentation/workflow.md index 137955d79b3..7c97f6628c9 100644 --- a/doc/development/documentation/workflow.md +++ b/doc/development/documentation/workflow.md @@ -382,7 +382,7 @@ Ensure the following if skipping an initial Technical Writer review: - Specific [user permissions](../../user/permissions.md) are documented. - That new documents are linked from higher-level indexes, for discoverability. - Style guide is followed: - - For [directories and files](styleguide.md#working-with-directories-and-files). + - For [directories and files](styleguide.md#work-with-directories-and-files). - For [images](styleguide.md#images). NOTE: **Note:** |