Commit 8f710dbd authored by Suzanne Selhorn's avatar Suzanne Selhorn

Merge branch 'eread/add-guidance-for-headings' into 'master'

Add additional points of guidance for headings

See merge request gitlab-org/gitlab!76715
parents 0a21580d a4a6de34
...@@ -791,6 +791,9 @@ This is overridden by the [documentation-specific punctuation rules](#punctuatio ...@@ -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/). 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 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. 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. - Leave exactly one blank line before and after a heading.
- Do not use links in headings. - Do not use links in headings.
- Add the corresponding [product badge](#product-tier-badges) according to the tier the - Add the corresponding [product badge](#product-tier-badges) according to the tier the
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment