Commit c247b67e authored by Suzanne Selhorn's avatar Suzanne Selhorn

Merge branch 'docs-style-guide-badge-header' into 'master'

Docs: Add note about product badges in headers

See merge request gitlab-org/gitlab!41797
parents 95cf5004 76cde2d1
...@@ -885,6 +885,11 @@ GitLab documentation from both the GitLab application and external sites. ...@@ -885,6 +885,11 @@ GitLab documentation from both the GitLab application and external sites.
Headings generate anchor links automatically when rendered. `## This is an example` Headings generate anchor links automatically when rendered. `## This is an example`
generates the anchor `#this-is-an-example`. generates the anchor `#this-is-an-example`.
NOTE: **Note:**
[Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/39717) in GitLab 13.4, [product badges](#product-badges) used in headings aren't included in the
generated anchor links. For example, when you link to
`## This is an example **(CORE)**`, use the anchor `#this-is-an-example`.
Keep in mind that the GitLab user interface links to many documentation pages Keep in mind that the GitLab user interface links to many documentation pages
and anchor links to take the user to the right spot. Therefore, when you change and anchor links to take the user to the right spot. Therefore, when you change
a heading, search `doc/*`, `app/views/*`, and `ee/app/views/*` for the old a heading, search `doc/*`, `app/views/*`, and `ee/app/views/*` for the old
......
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