Backport Dedicated add-on info for AI features
Why is this backport needed (background and context)
- Merge request to backport:
Get the approval of TW Leadership
The person requesting the backport does this step.
If the backport is for a version older than the latest stable branch, ask Technical Writing Leadership for approval:
-
Mention TW Leadership in a comment in this issue and wait for their approval: @gitlab-org/tw-leadership could I get your approval for this documentation backport?
I did this in this issue: https://gitlab.com/gitlab-org/gitlab/-/issues/458975#note_1918860267
Create the merge request to backport the change
The person requesting the backport does this step. Requires at least the Developer role on the project that needs the backport.
-
Open a merge request with the backport targeting the respective branch and link it to this issue. -
If the backport targets the current stable branch, assign to a Technical Writer to review and merge. Usually, the Technical Writer of the relevant group. -
If the backport targets any branch other than the latest stable branch, assign the MR to a Technical Writer for review. After it has TW approval, ask a release manager to review and merge the change. Mention this issue to them and give them all the context they need.
Deploy the backport change
A member of the Technical Writing team does this step. Usually, the same Technical Writer who reviewed the merge request.
After the change is backported to a stable branch, the Docker image that holds that version's docs needs to be updated:
-
Run a new pipeline in gitlab-docs
. Choose the branch name that matches the stable version, for example15.11
or16.0
.-
17.0 -
16.11
-
If the backport change was made to one of the last three stable branches, you need to update the main docs site:
-
After the pipeline finishes and the Docker image is updated, go to the pipeline schedules and run the Build docker images manually schedule. -
When the image:docs-latest
job is finished, run a new pipeline targeting themain
branch. -
After the pipeline finishes, go to https://docs.gitlab.com and verify that the changes are available for the respective version.
If the backport change was made to a version other than the last three stable branches, you need to update the docs archives site:
-
Run a new pipeline in gitlab-docs-archives
. -
After the pipeline finishes, go to https://archives.docs.gitlab.com and verify that the changes are available for the respective version.