Phased rollout of the Hugo site
The Hugo site is feature-complete. These lists track changes we need to make to complete our migration to Hugo.
Phase 1
When: Now–Feb 13
These can happen, and be merged, any time before the site launches.
They are compatible with Nanoc and /help in their current states.
| Status | Task | Who | Issue/MR(s) |
|---|---|---|---|
| Done | Add Hugo review apps | @eread |
#142 (closed) |
| Done | Move website project | @axil |
#177 (closed) |
| Done | Automated pages, part 1 (pages with only title or index name changes) | @sarahgerman |
MRs marked as pre-launch in #168 (closed) |
| Done | Rename index files and update titles on standard pages |
@eread + @marcel.amirault
|
#82 (closed) |
| Done | Add and enable Hugo test jobs and update markdown-lint images | @sarahgerman |
See list (8 MRs) |
| Done | Fix content flagged in migration audit |
@lealasmith + @sarahgerman
|
#76 (closed) |
| Done | Test moving a domain from one Pages site to another | @sarahgerman |
#186 (closed) |
| Done | QA testing | @marcel.amirault |
#164 (closed) |
Author, but do not merge yet:
| Status | Task | Who | Issue/MR(s) |
|---|---|---|---|
| Ready/approved | Automated pages, part 2 (pages with shortcodes) | @sarahgerman |
See list (4 MRs) |
| Ready/approved | Update documentation to reflect Hugo move |
@rlehmann1 + @sarahgerman
|
See list (~11 MRs) |
| Ready/approved | Find/replace all references of new.docs.gitlab.com in docs-gitlab-com
|
@HiruFernando12 |
!330 (merged) |
| Ready/Approved | Update redirect test in gitlab
|
@sarahgerman |
gitlab-org/gitlab!174060 (merged) |
| Ready/Approved | Update /help redirects |
@sarahgerman |
gitlab-org/gitlab!180776 (merged) |
Phase 2
When: Feb 14–Feb 16
Friday/Saturday before launch
| Status | Task | Who | Issue/MR(s) |
|---|---|---|---|
| Done | Remove markdown redirect pages for pages with path conflicts | @sarahgerman |
gitlab-org/gitlab-docs!5349 (merged) + gitlab-org/gitlab!180475 (merged) |
| Done | Copy over any updates to google-site-verification tags from gitlab-docs
|
@HiruFernando12 |
!330 (merged) |
| Done | Copy over any updates to landing.yaml from gitlab-docs
|
@HiruFernando12 |
!330 (merged) |
| Done | Update redirects.yaml and disable migration jobs in the Hugo project | @sarahgerman |
!336 (merged) |
Launch
Timing: Feb 16 Sunday night US central / Feb 17 Monday morning APAC
| Status | Task | Who | Issue/MR(s) |
|---|---|---|---|
| Done | Merge migration job removal in docs-gitlab-com
|
@sarahgerman |
!336 (merged) |
| Done | Merge MR to update references to domain name | @sarahgerman |
!330 (merged) |
| Done | Stop the hourly build CI job in gitlab-docs
|
@marcel.amirault |
https://gitlab.com/gitlab-org/gitlab-docs/-/pipeline_schedules |
| Done | Merge gitlab-org/gitlab!180806 (merged) | gitlab-org/gitlab!180806 (merged) | |
| Done | Update content by running migration scripts against the docs in each source content repo |
@sarahgerman to author / TW to merge |
gitlab-org/gitlab!181610 (merged) + gitlab-org/cloud-native/gitlab-operator!1084 (merged) + gitlab-org/charts/gitlab!4131 (merged) + gitlab-org/gitlab-runner!5362 (merged) + gitlab-org/omnibus-gitlab!8174 (merged) + gitlab-org/gitlab!181591 (merged) |
| Done | Merge automated page template updates (needs Backend approval) |
@sarahgerman to recompile pages if needed / @eread / @marcel.amirault / @michael.belton to merge |
gitlab-org/gitlab!177193 (merged) + gitlab-org/gitlab!178795 (merged) + gitlab-org/gitlab-runner!5258 (merged) |
| Done | Verify the site builds as expected with real content |
@sarahgerman + @eread + @marcel.amirault + @michael.belton
|
n/a |
| Done | Ping CMOC to add maintenance notice to status page | @michael.belton |
http://gitlab.com/gitlab-org/technical-writing/docs-gitlab-com/-/issues/44#note_2345206560 |
| Done | Move the domain name to the new project, DNS + Cloudflare changes | @ayeung |
gitlab-com/gl-infra/production#19235 (closed) |
| Done | Merge /help redirect update (backend pre-approved) |
@eread / @marcel.amirault / @michael.belton
|
gitlab-org/gitlab!180776 (merged) |
| Done | Merge updated lint-docs-redirects.rb (tooling pre-approved) |
@eread / @marcel.amirault / @michael.belton
|
gitlab-org/gitlab!174060 (merged) |
| Done | Update Elasticsearch index settings to point at production domain | @sarahgerman |
Elastic admin |
| Done | Merge Hugo-related documentation updates |
@eread / @marcel.amirault / @michael.belton
|
gitlab-org/gitlab!176057 (merged) |
| Done | CI variables: Set ANALYTICS_ENABLED to true
|
@sarahgerman |
https://gitlab.com/gitlab-org/technical-writing/docs-gitlab-com/-/settings/ci_cd#js-cicd-variables-settings |
| Done | Verify site and search functionality | @sarahgerman |
n/a |
| Done | Ping CMOC to remove status page notice | @michael.belton |
n/a |
When this is complete, notify the team with Slack posts in #tw-team, #docs, and #whats-happening-at-gitlab.
Phase 3
When: Feb 17–21
Lower-priority updates that can be completed after the new site is live, and we've verified everything is working smoothly.
| Status | Task | Who |
|---|---|---|
| Done | Drop remaining references to test domain | @sarahgerman |
| Done | Verify analytics are collecting data | @sarahgerman |
| Done | Close gitlab-docs open MRs / notify authors |
@sarahgerman |
| Done | Check the migration audit again for new issues | @sarahgerman |
| Done | Review and close gitlab-docs issue queue |
@sarahgerman |
| Done | Create issues from QA to close #164 (closed) | @sarahgerman |
| Done | Update docs links on the architecture diagram gitlab-org/gitlab!181700 (merged) | @sarahgerman |
| Done | Remove gitlab-docs-nanoc Elastic search index |
@HiruFernando12 |
| Done | Decide how to do a project retrospective | @sarahgerman |
| Done | Clean up remaining Nanoc code (Issue) |
@sarahgerman + @eread
|
| Done | Remaining documentation issues | @sarahgerman |
| See #271 (moved) | Update full URLs in all projects + handbook (drop ee/ and change .html to /) |
@marcelamirault & friends |
Edited by Sarah German