Method to add tier support badge to doc headers without affecting anchors
Request
We need a way to be able to have something similar to this appear in our docs for features and pages that are available only at certain tier levels:
...but not look like this in the Markdown files:
### Group events **(STARTER)**
The problem we've encountered is that if the name of the tiers change, then we'd have to replace the Starter reference in the header. The problem is that the current anchor for the header is #group-events-starter
and putting a different tier name into the Markdown changes the anchor to #group-events-new_name
, which breaks links on other pages to this section.
Ideally, the header wouldn't include the associated tier information (so its anchor would be #group-events
), but we'd have some method to include the relevant tier, while also maintaining the look and feel of the current site, and how it displays the supported tiers with headers.
But, if the look needs to change some, that's also okay. The primary thing we need is to get the tiers out of the headers, so that future changes don't involve verifying links throughout the docset.
Migration plan
-
Merge !39717 (merged) (TW) It removes product tiers from generated anchors from
/help
pages -
Merge gitlab-docs!1070 (merged) (TW) It removes product tiers from generated anchors from
docs.gitlab.com
pages -
Update docker images for docs.gitlab.com project. (TW) We need to update docs linter to use new generated anchors logic (from gitlab-docs!1070 (merged)), otherwise tests will keep failing. I think that running
Build docker images weekly
scheduled task should be enough, but let me know if I'm missing something -
Rebase !39715 (merged) and make sure that there are no CI failures (Vasilii) -
Merge !39715 (merged) (TW) -
Test that links with anchors work in both /help
anddocs.gitlab.com
(TW and Vasilii)
After that the main part of the migration is finished.
Follow-up issues (can be merged later):