Improve docs experience for Experience Baseline JTBD: Create a Release and update it
As part of the FY20-Q4 documentation OKR gitlab-design#692 (closed), this issue pertains to a "job to be done" (JTBD) in GitLab--"Create a Release and update it"--which has been evaluated by UX as part of an Experience Baseline Review.
If you are working on this issue, review the linked OKR and the Experience Baseline Recommendations Handbook page for more detail. Then review the links below, per the OKR instructions.
UX Evaluation issue - gitlab-design#431 (closed)
UX recommendations issue - gitlab-design#505 (closed)
Potential doc work - Flesh out our releases page to show the current state of the feature; how to manage a release using the current features
Notes - https://docs.gitlab.com/ee/workflow/releases.html
Product designer - @rverissimo
Based on the steps in the OKR epic, use the checkboxes to indicate when each step is complete, and use the format below for notes and plans. You are welcome to alternatively link any/all subsections to an additional issue or a Google doc, to work there instead.
-
Review existing info -
Review SEO -
Document and improve SEO
-
-
Consider potential UI doc link -
Review and improve documentation content -
Test the instructions -
Plan documentation improvements/additions -
Ask questions of and share plans with Product Designer -
Implement doc changes
-
Plans & Notes
1. Review existing info
2. Review SEO
a. Document and improve SEO
3. Consider potential UI doc link
Covered in !22116 (merged)
-
Update UI text for an empty Releases page in app.vue#L69, following UX recommendation: Releases are based on Git tags and mark specific points in a project's development history. They can contain information about the type of changes and can also deliver binaries, like compiled versions of your software.
-
State clearly in the documentation that using the API is not the only way to create a release.
4. Review and improve documentation content
Covered in !21755 (merged)
-
Update screenshots in Add release notes to Git tags -
Clean up style issues in the Tags and Releases page.