Update the categories table to contain valid and predictable links
Goal
The Platform Page creates a table of GitLab features based off of the data present in categories.yml which loads all features by name
and sorts them by stage
Currently, some items may not have a feature page to point to and this can cause broken links. To resolve this issue I propose the following solution:
- Add a separate key
feature_page
in categories.yml - Update the table in the platform page to
- If feature is
mature
1. Add thefeature_page
as the link 1. If nofeature_page
add themarketing_page
as a link 1. If nomarketing_page
add thedocumentation
as a link (Note: consider not using documentation pages since it takes you away from the marketing site) 1. If nodocumentation
exclude it from the table - If feature is
planned
1. Add thedirection
link 1. If nodirection
exclude it from the table - Test the changes and make sure no link is broken
- Add a README to the categories.yml directory explaining how the keys are used
Jobs To Be Done
- Revert categories table to use
marketing_page
>documentation
instead of feature page(regex): !3630 (merged) - Update the categories.yml to include
feature_page
: gitlab-com/www-gitlab-com!133823 (merged) - Update categories table to us
feature_page
>marketing_page
>documentation
: !3656 (merged) - Add documentation for categories.yml: Done
Page(s)
Which page(s) are involved in this request?
DCI
- DRI: @fjdiaz
- Consulted: @esalvadorp
- Informed: @johncoghlan
Edited by Fern