Add description from release post content into GitLab-org releases page
Problem to solve
We implemented a fantastic view of the about.gitlab.com releases page inside of GitLab by using the Releases feature functionality. Users are interested in no longer being dependent on the Release Post to populate the Releases pages.
Intended users
- Rachel (Release Manager)
- Parker (Product Manager)
- All internal GitLab Users
User experience goal
As a user, I want to be able to see a brief description of the feature right on the releases page without having to go to documentation
Proposal
- Add the description keyword attribute from the release post to be pulled into the GitLab.org page
- Synchronize
description
field from the feature YAML. e.g. https://gitlab.com/gitlab-com/www-gitlab-com/-/blob/master/data/release_posts/13_1/phikai-webide-core-features.yml#L12 - Make sure the
description
is visible in https://gitlab.com/gitlab-org/gitlab/-/releases (mirror page). - If necessary, adjust the page style (GFM).
Future implications
- We may want to consider what ever header we use to stay the same from how this gets pulled into the release notes section of the release page
- We will also need to consider a character limit and images if people want those to be included
Edited by Shinya Maeda