diff options
| author | GitLab Bot <gitlab-bot@gitlab.com> | 2021-12-15 03:13:13 +0300 |
|---|---|---|
| committer | GitLab Bot <gitlab-bot@gitlab.com> | 2021-12-15 03:13:13 +0300 |
| commit | 77e775460553ceadedada8779b474e9ecde3e42d (patch) | |
| tree | 8dba88a4082ffd0d4b586f525e0a28994195350e /doc/development/documentation | |
| parent | 30f908f6b9689ecda34474e68c55ce4dba1a9974 (diff) | |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc/development/documentation')
| -rw-r--r-- | doc/development/documentation/styleguide/index.md | 3 |
1 files changed, 3 insertions, 0 deletions
diff --git a/doc/development/documentation/styleguide/index.md b/doc/development/documentation/styleguide/index.md index 7e9bd5be9df..29dfca03cbb 100644 --- a/doc/development/documentation/styleguide/index.md +++ b/doc/development/documentation/styleguide/index.md @@ -791,6 +791,9 @@ This is overridden by the [documentation-specific punctuation rules](#punctuatio for review, based upon the [product category](https://about.gitlab.com/handbook/product/categories/). This is to ensure that no document with wrong heading is going live without an audit, thus preventing dead links and redirection issues when corrected. +- Use the context provided by parent section headings. That is, don't repeat the parent heading's text in each + subsection's heading. +- Use articles and prepositions in headings where it would make sense in regular text. - Leave exactly one blank line before and after a heading. - Do not use links in headings. - Add the corresponding [product badge](#product-tier-badges) according to the tier the |