View Description Change History
Engineer(s): @fatihacet, @engwan | Product Marketing: @johnjeremiah | Tech Writer: @rdickenson
Content checklist
-
Description is informative and focuses on the problem we're solving and the value we're delivering -
Check feature and product names are in capital case -
Check headings are in sentence case -
Check Feature availability (Core, Starter, Premium, Ultimate badges) -
Make sure feature description is positive and cheerful -
Ensure all text is consistently hard wrapped at a suitable column boundary -
Check documentation link points to the latest docs ( documentation_link
) -
Check that documentation is updated and easy to understand -
Check that all links to about.gitlab.com content are relative URLs -
Run the content through an automated spelling and grammar check -
Validate all links are functional and have meaningful text for SEO (e.g., "click here" is bad link text) -
Remove any remaining instructions (comments) -
Feature is added to data/features.yml
(with accompanying screenshots)
Review
When the above is complete and the content is ready for review, it should be reviewed by Product Marketing and Tech Writing:
-
PMM review -
Tech writing
References
- Issues: gitlab-org/gitlab#32894 (closed)
- Merge requests:
- Soft-deletion of history (backend): gitlab-org/gitlab!21439 (merged)
- Release post (optional):
Edited by Justin Farris