Prepare automated pages for Hugo
We have several automated pages on the website: https://docs.gitlab.com/ee/development/documentation/site_architecture/automation.html
Most of these are created from templates in the gitlab project, with Rake tasks that transform data from elsewhere into markdown format.
These pages are not handled by our general migration scripts since their content is dynamic. We'll need to find and update the code that creates each one.
Changes needed for Hugo:
- Rename
index.mdfiles to_index.md - Adjust links that point to
index.mdfiles to point to_index.md - Move h1 titles to
title:front matter. - Rewrite custom elements (alerts, history, feature details, SVG icons, tabs) as shortcodes.
We should do steps 1-3 in advance; step 4 will have to be MRs that we merge as part of launch.
Updates to merge
| Page | MR | When to merge | Recompile command |
|---|---|---|---|
| DAST checks | https://gitlab.com/gitlab-org/security-products/dast-cwe-checks/-/merge_requests/247 | Pre-launch |
./scripts/regenerate_docs.sh ../gitlab (fixed) |
| GraphQL reference page title + filename | gitlab-org/gitlab!178234 (merged) | Pre-launch |
bundle exec rake gitlab:graphql:compile_docs |
| GitLab Runner k8s API | gitlab-org/gitlab-runner!5327 (merged) | Pre-launch |
mage k8s:generatePermissionsDocs |
| Breaking change windows | gitlab-org/gitlab!180253 (merged) | Pre-launch |
bundle exec rake gitlab:docs:compile_windows |
| Deprecations | gitlab-org/gitlab!177193 (merged) (ready, approved) | Launch |
bundle exec rake gitlab:docs:compile_deprecations |
| Audit event types | gitlab-org/gitlab!177193 (merged) (ready, approved) | Launch |
bundle exec rake gitlab:audit_event_types:compile_docs |
| Available custom role permissions | gitlab-org/gitlab!177193 (merged) (ready, approved) | Launch |
bundle exec rake gitlab:custom_roles:compile_docs |
| CI/CD Job token fine-grained permissions (ready, approved) | gitlab-org/gitlab!177193 (merged) | Launch |
bundle exec rake ci:job_tokens:compile_docs |
| GraphQL reference shortcodes | gitlab-org/gitlab!178795 (merged) (ready, approved) | Launch | bundle exec rake gitlab:graphql:compile_docs |
| GitLab Runner feature flags | gitlab-org/gitlab-runner!5258 (merged) (ready, approved) | Launch | make update_feature_flags_docs |
Edited by Achilleas Pipinellis