FY25Q4 Stage Lead planning issue: Plan
This issue outlines the projects that will be the focus of the devopsplan stage lead during Q4 of FY25.
Themes
Fill identified gaps in example use cases
- Short description: Address identified needs for use case examples in Plan docs
- Reasoning: These issues were identified as high-impact backlog items.
- Note:
| Issue | Group(s) | Status | Effort | Priority | Details | MR |
|---|---|---|---|---|---|---|
| Epics linked items widget - update docs with us... (gitlab-org/gitlab#407465 - closed) | groupproduct planning |
|
Medium | Medium | Create practical use cases for linking epics and increase adoption. Target milestone is 17.8. Led by: Technical Writer (Marcin) |
gitlab-org/gitlab!175157 (merged) |
|
|
groupproject management |
|
High | Medium | Make the Iterations documentation more practical and user-friendly by adding real-world use cases and clarifying its relationship with Agile concepts. Target milestone is 17.8. Led by: Technical Writer (Marcin) |
gitlab-org/gitlab!177760 (merged) |
Triage Knowledge docs backlog
- Short description: Until 17.3 groupknowledge has been without a dedicated TW, and their docs backlog needs triaging.
- Reasoning: TW workflow Review and triage docs-only backlog issues
- Status:
✅ : Complete
I reviewed issues that are not typebug, not typefeature, not development guidelines that have not been triaged:
- Issues with documentation: issue board.
- Scheduled for the upcoming milestone, regardless of documentation: issue list.
Current docs-only backlog for Plan
Results:
- I triaged around 150 issues.
- I took over and finished a stale MR Add Confluence integration documentation (gitlab-org/gitlab!154085 - merged).
- I closed 9 issues:
- Docs feedback: API docs don't describe how to g... (gitlab-org/gitlab#244879 - closed)
- Remove Pages documentation for self-compiled in... (gitlab-org/gitlab#469459 - closed)
- Update rich text editor developer documentation (gitlab-org/gitlab#477065 - closed)
- Can not load docs.gitlab.com (gitlab-org/gitlab#355830 - closed)
- Docs: Define prerequisites in Let's Encrypt pag... (gitlab-org/gitlab-pages#737 - closed)
- Docs: Identify content better suited to doc/topic (gitlab-org/gitlab-pages#742 - closed)
- Docs: Target index to non-developer personas an... (gitlab-org/gitlab-pages#743 - closed)
- Docs: Add developer docs to the left navigation (gitlab-org/gitlab-pages#744 - closed)
- Update GitLab Pages documentation to cover NFS ... (gitlab-org/gitlab#441756 - closed)
- I organized the remaining issues into the two existing epics:
Plan IA changes for new work item types
- Short description: Create IA foundations to start using "work items" to refer to them in the docs - not because of what's underneath, but because they're items to plan work. This will be helpful in docs and UI text when instead of "issue boards" and epic boards" we have configurable boards where you decide which work item types you put there.
- Reasoning: As we're introducing more work item types (OKRs, tasks, epics, soon issues), the amount of repeated content in the docs site grows.
- Status:
✅ : Complete
Results:
- Created epic Docs IA: Reorganize the "Plan and track work" s... (gitlab-org&16344 - closed). Proposed new nav structure and new "Linked items" page
- Created MR to delete unnecessary UI docs link: Delete redundant docs link from "Linked items" (gitlab-org/gitlab!176373 - merged)
Legend:
-
⏳ : Waiting for<...>.technical writer, orPM input, orEngineering input -
🚧 : In progress -
✅ : Complete -
🏋🏽 : Stretch goal (add next to any item that is aspirational this quarter)
Ongoing tasks
- Plan Stage Lead issue board: https://gitlab.com/groups/gitlab-org/-/boards/7825333
- Specific TW milestone planning issues:
- KRs:
-
https://gitlab.com/gitlab-org/technical-writing/-/issues/1203+ -
January 2025: docs maintenance: https://gitlab.com/gitlab-org/technical-writing/-/issues/1229+
References
Edited by Marcin Sedlak-Jakubowski