Shadow Technical Writing team during monthly documentation release
Overview
The Localization team needs to understand the Technical Writing team's documentation release process to develop an effective strategy for managing localized content releases and version branches. By shadowing the documentation release process for GitLab 18, we should observe and document the workflow, and create a plan for how localization activities should align with docs release management.
Goal
- Understand the practical aspects of version branch creation (naming, timing, maybe even down to specific commands, etc.)
- Understand the pipeline execution for docs deployment
- Understand how redirects are managed
- Observe how in-progress content (i.e. continuous .md changes in regular MRs) is handled during branch creation
- Identify decision points and their impact on localization management
- Determine implications for forks management, plan / timeline for localized releases (we may not need localized releases, because we are currently merging Translation MRs from forks into master/main of upstream, but need a plan), localization engineer involvement, localization program manager involvement, etc.
- Determine whether continuous localization between releases is necessary or if aligning with the release timeframes is more efficient
- Create a proposed workflow (and plan if applicable) for localized releases
References
- Monthly documentation releases (TW team's docs): https://gitlab.com/gitlab-org/technical-writing/docs-gitlab-com/-/blob/main/doc/releases.md
- 'Tasks for all releases' issue template: https://gitlab.com/gitlab-org/technical-writing/docs-gitlab-com/-/blob/main/.gitlab/issue_templates/release.md
- Example issue to shadow: docs.gitlab.com release 17.11 (April, 2025) (gitlab-org/technical-writing/docs-gitlab-com#305 - closed)
- Relevant localization discussions: Design versioning and release process for local... (#88)
Edited by Oleksandr Pysaryuk