FY24Q3 KR: Spike: Improve docs experience for self-managed administrators => 100%
The documentation for administrators gets six percent of our total pageviews. This area is fourth after "Use GitLab," "Install," and "Develop." This section has gotten little attention for some period of time.
The documentation for administrators has the following issues:
- It is likely out-of-date.
- It is disorganized.
- It's never been reviewed as a whole.
We need to determine the best way to present this information.
Scope
This OKR is primarily about researching and categorizing the existing documentation. This OKR should answer these questions:
- Is there content that is obviously out-of-date?
- Are there pages that are solely reiterating the UI and can be changed to be task-based?
- Does the nav organization make sense or can we organize better/improve further?
The result of this OKR should be:
- A list of pages to be CTRT'd (for a possible future team OKR)
- A list of pages that are clearly out-of-date or can be removed
- Improvements to the existing left nav
Tasks
I will review each page and categorize it (OK as-is
, Needs CTRT
, or Remove altogether
). There are 268 files total. The full list is available and progress tracked in this spreadsheet.
-
Review 50 pages -
Review 50 more (100 total) -
Review 50 more (150 total) -
Review 50 more (200 total) -
Review 50 more (250 total) -
Review ~20 remaining (268 total) -
Review the left nav and open an issue with recommendations
Edited by Susan Tacker