KR: Review and revise UI text on Settings pages => 18/25, 76%
Part of the FY21-Q4 UX Department OKRs.
FY21-Q4 Tech Writing /UX OKR: Improve GitLab Settings experience by clarifying UI text
The UI text on GitLab Settings pages needs to be reviewed and edited for wordiness, passive voice, inconsistency, and future tense. Are the field descriptions clear? You may discover other issues to fix as well.
First, we will use the Pajamas UI text guidance voice and tone requirements. Familiarize yourself with the guidelines in the entire "Content" section of Pajamas.
We will not change field names or button names unless they're egregious, because we'd also have to then go fix the doc.
Current tally (as of Jan 31): 19 completed issues out of 25 (76% of goal)
Incomplete items moved to following QTR OKR.
Background
- Every Technical Writer will review UI text for the Settings sections for General, CI/CD, and Repository within the GitLab application.
- After completing their review, Technical Writers will make relevant updates to their assigned sections' wording within the code.
- Issues have already been created for each section that needs a review.
OKR Process
- TWs should self-assign 2-3 issues throughout the quarter; not all at once, but one open issue at a time.
- Assign yourself to the issue created for the section you're working on, and add your name to the following table for that section.
Settings section list
Settings | Section | Issue | Technical Writer |
---|---|---|---|
General | Naming, topics, avatar | #308 (closed) | @mjang1 |
General | Visibility, project features, permissions | #309 (closed) | @rdickenson |
General | Merge requests | #310 (closed) | @msedlakjakubowski |
General | Merge request approvals | #311 (closed) | @mjang1 |
General | Badges | #312 (closed) | @eread |
General | Default issue template | #313 (closed) | @axil |
General | Service Desk | #314 (closed) | @eread |
General | Advanced | #315 (closed) | @axil |
CI/CD | General pipelines | gitlab#298822 (closed) | @marcel.amirault |
CI/CD | Auto DevOps | #317 (closed) | @aqualls |
CI/CD | Protected Environments | #318 (closed) | @ngaskill |
CI/CD | Runners | #319 (closed) | @sselhorn |
CI/CD | Variables | gitlab#299828 (closed) | @marcel.amirault |
CI/CD | Pipeline triggers | #321 (closed) | @nadia_sotnikova (UX)/@sselhorn |
CI/CD | Cleanup policy for tags | #322 (closed) | @sselhorn |
CI/CD | Deploy freezes | #323 (closed) | @marcia |
CI/CD | Pipeline subscriptions | #324 (closed) | @eread |
Repository | Default Branch | #325 (closed) | @ngaskill |
Repository | Push Rules | #326 (closed) | @marcia |
Repository | Mirroring repositories | #327 (closed) | @axil |
Repository | Protected Branches | #328 (closed) | @aqualls |
Repository | Protected Tags | #329 (closed) | @aqualls |
Repository | Deploy Tokens | #330 (closed) | @mjang1 |
Repository | Deploy Keys | #331 (closed) | @marcia |
Repository | Repository cleanup | #332 (closed) | @ngaskill |
Links and references
We are tackling a subset of all GitLab Settings pages. The complete list is here: