Stage 4: Do communication and documentation updates for new auto-deploy pipeline
This issue is to track any documentation updates and communication that we need to do as part of re-ordering the pipeline.
Includes
-
Reviewing https://gitlab.com/gitlab-org/release/docs for any needed changes -
Reviewing https://gitlab.com/gitlab-com/runbooks for any needed changes -
Reviewing the Gitlab handbook for any needed changes -
Do an announcement and possible Q&A ahead of the final change over -
Do announcement once change over is complete
Changes that have been identified as needing to be done
-
Documentation about staging-canary as an environment, and how to use it -
Add a full page about canary environments and how they work (and how to do some specific tasks) under the environments section of the handbook gitlab-com/www-gitlab-com!99839 (merged) -
Update environments page with complete information about staging-canary, making sure to include information about the short names we use (e.g. "gstg-cny") gitlab-com/www-gitlab-com!99435 (merged)
-
-
Documentation/runbooks about what to when various parts of the deploy pipeline fail/go wrong -
Runbook on how to deploy to a single environment gitlab-org/release/docs!438 (merged)
-
-
Documentation/runbooks specifically about the pipeline re-order -
Add documentation about the new deploy pipeline to the handbook here gitlab-com/www-gitlab-com!99530 (merged) -
Update hotpatch documentation to be accurate and provide information on what to do or consider post pipeline-reorder here -
Write up announcements relating to start of testing/cutover #2280 (closed)
-
Acceptance Criteria
-
Developers at Gitlab have accurate documentation about the staging-canary environment, and how to use it -
Developers at Gitlab have accurate documentation about the new pipeline order, and can determine the order in which their code progresses to production -
Release Managers have accurate documentation about what the new pipeline looks like -
Release Managers have up to date documentation about how deploy a release to a specific environment, that covers any considerations with the pipeline re-order -
Release Managers have up to date documentation about rollbacks that covers any considerations with the pipeline re-order -
Release Managers have up to date documentation about hotpatches that covers any considerations with the pipeline re-order
Edited by Graeme Gillies