Rename index files and update page titles on standard pages
The move to Hugo requires:
- renaming
index.md
files to_index.md
- moving page titles from
h1
markdown elements totitle:
front matter attributes
We've modified Nanoc and /help
to work with these changes, so we can make these updates before actually launching, but it will take a few steps:
- Rename the files (see
content-post-process.sh
) - Update links that point to index.md files (see
migrate-index-links.go
) - For
gitlab
only: update UI help links that point toindex.md
files - Add (or enable) the new
FrontMatter.yml
Vale rule (gitlab-org/gitlab!178753 (merged)).
Projects
Mark these done when we've merged an MR that renames the index files, and migrates the page titles.
-
gitlab operator: gitlab-org/cloud-native/gitlab-operator!1066 (merged) -
gitlab charts: gitlab-org/charts/gitlab!4101 (merged) -
omnibus gitlab: gitlab-org/omnibus-gitlab!8148 (merged) -
gitlab runner: gitlab-org/gitlab-runner!5327 (merged) -
gitlab: -
doc/administration
:- Headers only:
-
doc/administration
batch 1: gitlab-org/gitlab!180659 (merged) -
doc/administration
batch 2: gitlab-org/gitlab!180676 (merged) -
doc/administration
batch 3: gitlab-org/gitlab!180678 (merged) -
doc/administration
batch 4: gitlab-org/gitlab!180679 (merged) -
doc/administration
batch 5: gitlab-org/gitlab!180684 (merged) -
doc/administration
batch 6: gitlab-org/gitlab!180702 (merged)
-
doc/api
: gitlab-org/gitlab!180301 (merged) -
doc/architecture
: gitlab-org/gitlab!180110 (merged) -
doc/ci
: gitlab-org/gitlab!180467 (merged)
Splitting up:-
doc/ci/yaml/index.md
: gitlab-org/gitlab!180508 (merged) -
doc/ci/variables/index.md
anddoc/ci/environments/index.md
: gitlab-org/gitlab!180510 (merged) - Headers only: Docs: Update headers for CI/CD docs (gitlab-org/gitlab!180546 - merged)
-
-
doc/cloud_seed
: gitlab-org/gitlab!180123 (merged) -
doc/development
: gitlab-org/gitlab!179949 (merged) -
doc/downgrade_ee_to_ce
: gitlab-org/gitlab!180123 (merged) -
doc/editor_extensions
: gitlab-org/gitlab!180123 (merged) -
doc/install
: gitlab-org/gitlab!180137 (merged) -
doc/integration
: gitlab-org/gitlab!180871 (merged) -
doc/operations
: gitlab-org/gitlab!180123 (merged) -
doc/policy
: gitlab-org/gitlab!180123 (merged) -
doc/raketasks
: gitlab-org/gitlab!180123 (merged) -
doc/security
: gitlab-org/gitlab!180137 (merged) -
doc/solutions
: gitlab-org/gitlab!180123 (merged) -
doc/subscriptions
: gitlab-org/gitlab!180633 (merged) -
doc/topics
: gitlab-org/gitlab!180636 (merged) -
doc/tutorials
: gitlab-org/gitlab!180639 (merged) -
doc/user
:-
doc/user/admin_area
: gitlab-org/gitlab!180507 (merged) -
doc/user/analytics
: gitlab-org/gitlab!180507 (merged) -
doc/user/application_security
: gitlab-org/gitlab!180670 (merged) -
doc/user/clusters
: gitlab-org/gitlab!180656 (merged) -
doc/user/compliance
: gitlab-org/gitlab!180656 (merged) -
doc/user/crm
: gitlab-org/gitlab!180660 (merged) -
doc/user/discussions
: gitlab-org/gitlab!180660 (merged) -
doc/user/enterprise_user
: gitlab-org/gitlab!180660 (merged) -
doc/user/gitlab_com
: gitlab-org/gitlab!180668 (merged) -
doc/user/glql
: gitlab-org/gitlab!180660 (merged) -
doc/user/group
:-
doc/user/group/clusters
: gitlab-org/gitlab!180862 (merged) -
doc/user/group/contribution_analytics
: gitlab-org/gitlab!180862 (merged) -
doc/user/group/devops_adoption
: gitlab-org/gitlab!180862 (merged) -
doc/user/group/epics
: gitlab-org/gitlab!180862 (merged) -
doc/user/group/import
: gitlab-org/gitlab!180862 (merged) -
doc/user/group/issues_analytics
: gitlab-org/gitlab!180862 (merged) -
doc/user/group/iterations
: gitlab-org/gitlab!180868 (merged) -
doc/user/group/reporting
: gitlab-org/gitlab!180868 (merged) -
doc/user/group/repository_analytics
: gitlab-org/gitlab!180868 (merged) -
doc/user/group/roadmap
: gitlab-org/gitlab!180868 (merged) -
doc/user/group/saml_sso
: gitlab-org/gitlab!180868 (merged) -
doc/user/group/settings
: gitlab-org/gitlab!180868 (merged) -
doc/user/group/subgroups
: gitlab-org/gitlab!180868 (merged) -
doc/user/group/value_stream_analytics
: gitlab-org/gitlab!180868 (merged)
-
-
doc/user/infrastructure
: gitlab-org/gitlab!180875 (merged) -
doc/user/instance
: gitlab-org/gitlab!180875 (merged) -
doc/user/namespace
: gitlab-org/gitlab!180875 (merged) -
doc/user/operations_dashboard
: gitlab-org/gitlab!180875 (merged) -
doc/user/organization
: gitlab-org/gitlab!180875 (merged) -
doc/user/
(everything else not inuser/project
): gitlab-org/gitlab!180923 (merged) -
doc/user/project/
:-
doc/user/project/repository/code_suggestions/
: gitlab-org/gitlab!180812 (merged) -
doc/user/project/repository/code_owners/
: gitlab-org/gitlab!180757 (merged) -
doc/user/project/merge_requests/
: gitlab-org/gitlab!180591 (merged) -
doc/user/project/repository - 1
: gitlab-org/gitlab!180759 (merged) -
doc/user/project/repository - 2
: gitlab-org/gitlab!180794 (merged) -
doc/user/project - deploy/release/pages
: @marcel.amirault -
doc/user/project/ misc 1
: gitlab-org/gitlab!180928 (merged) -
doc/user/project/ misc 2
: gitlab-org/gitlab!180934 (merged) -
doc/user/project/ misc 3
: gitlab-org/gitlab!180937 (merged) -
doc/user/project/ misc 4
: gitlab-org/gitlab!180940 (merged)
-
-
doc/user/packages
:-
doc/user/packages/ - 1
: gitlab-org/gitlab!180841 (merged) -
doc/user/packages/ - 2
: gitlab-org/gitlab!180852 (merged) -
doc/user/packages/container_registry
: gitlab-org/gitlab!180741 (merged)
-
-
Headers only:
- Docs: Update headers for user docs - 1 (app sec) (gitlab-org/gitlab!180559 - merged)
- Docs: Update headers for user docs - 2 (app sec) (gitlab-org/gitlab!180560 - merged)
- Docs: Update headers for user docs - 3 (gitlab-org/gitlab!180561 - merged)
- Docs: Update headers for user docs - 4 (gitlab-org/gitlab!180562 - merged)
- Docs: Update headers for user docs - 5 (gitlab-org/gitlab!180563 - merged)
-
-
doc/update
: gitlab-org/gitlab!180137 (merged) -
(Draft) doc/update/breaking_windows.md
,doc/update/deprecations.md
,doc/user/compliance/audit_event_types.md
,doc/user/custom_roles/abilities.md
: gitlab-org/gitlab!177193 (merged) -
Files that use full URLs (not relative links), including code comments:
-
Please skip automated pages when updating the standard pages; automated pages are handled in separate MRs.
Tests
-
Create a test to ensure new pages are named _index.md
rather thanindex.md
(#161 (closed)) -
Create a test to require the new page title format (gitlab-org/gitlab!178753 (merged)).
Related:
Edited by Marcel Amirault