Draft: Update registry paths on Archives page
What does this MR do and why?
Adds handling for a third Archives image endpoint, used for listing archive images on this page: https://new.docs.gitlab.com/archives/
Holding as a Draft for now. To finish this, we'll need to add the actual image endpoint URL (we'll have this when #35 (closed) is done).
Screenshots, screen recordings, or links to review app
Before | After |
---|---|
How to set up and validate locally
Numbered steps to set up and validate the change are strongly suggested.
-
Configure a local GitLab Docs environment: https://gitlab.com/gitlab-org/technical-writing-group/gitlab-docs-hugo/-/blob/main/doc/setup.md. -
Verify that the Archives page uses the Hugo URL for versions newer or equal to the hugoLaunchVersion
parameter, which is set inconfig/_default/hugo.yaml
: - Edit
hugo.yaml
locally and set the value ofhugoLaunchVersion
to a recently released version (like 17.5) - Run
make view
and visit the archives page (http://localhost:1313). You should see the new Hugo project registry path in the Archive list for versions equal to or newer than$hugoLaunchVersion
-
Verify that the Versions menu (the other user of $hugoLaunchVersion
) still works correctly: - With
hugoLaunchVersion
inhugo.yaml
still set to a recent version, visit any interior content page (like http://localhost:1313/user/application_security/secure_your_application/) - Check the links on the Versions dropdown. Versions equal to or newer than
hugoLaunchVersion
should use a Hugo-style URL (no "ee" prefix, no.html
suffixes), and versions older thanhugoLaunchVersion
should use Nanoc-style URLs, which should actually work and get you to the appropriate archive page.
Merge request acceptance checklist
This checklist encourages us to confirm any changes have been analyzed to reduce risks in quality, performance, reliability, security, and maintainability.
-
I have evaluated the MR acceptance checklist for this merge request.
Closes #155
Edited by Sarah German