What's New - YAML Entry
Overview
As an iteration towards gitlab-org&3556, we want to leverage a YAML file for entering the What's New updates that closely resembles the YAML files used for our release posts.
I created a spreadsheet with example entries for the previous 3 releases here: https://docs.google.com/spreadsheets/d/1BVU8kK0lMTXcvBvEkNYedda7EXNTkqh2ur-miW3unu0/edit#gid=0
The following fields would be required:
- Release
- Headline
- Body
- Self-managed (true or false)
- .com (true or false)
- Billing packages it applies to
- URL for CTA
- CTA label
- Image URL
- Publish date
- Expire date (can be n/a)
Optional:
- Stage (we don't plan currently to do anything in the UI with this but I could see us using it in the future to prioritize the updates that are shown)
Behavior
- For .com users, when the YAML file is updated, users will see the changes ASAP. Ideally this is within hours but I understand we may have limitations here and we should leverage the twice-weekly deploys instead
- For self-managed users, the YAML file is deployed with the release, allowing air-gapped customers to see What's New as well
- For self-managed users on previous versions, they will be allowed to pull this information down from the versions app via gesturing in the What's New menu on the instance. (This behavior should likely be a separate issue)
Additional Info
Example YML files from release posts:
- https://gitlab.com/gitlab-com/www-gitlab-com/-/blob/master/data/release_posts/13_1/alert_managment.yml
- https://gitlab.com/gitlab-com/www-gitlab-com/-/blob/master/data/release_posts/13_1/Feature_Flag_strategy_ui.yml
- https://gitlab.com/gitlab-com/www-gitlab-com/-/blob/master/data/release_posts/13_1/a11y-merge-request-widget.yml
And release post documentation: https://about.gitlab.com/handbook/marketing/blog/release-posts/#content-blocks
Edited by Michael Karampalas