Added archives pages with markdown and hugo template
What does this MR do and why?
Describe why, not just what. Include links to relevant issues or discussions.
-
This MR adds archives listing to archives page using Hugo template.
-
This MR DOES NOT cover
Copy to Clipboard
functionality. Covered under in this issue. -
This MR DOES NOT cover
Help & Feedback
functionality. Covered under in this issue.
Screenshots, screen recordings, or links to review app
This screenshot shows code blocks as well
Show error banner if V1 or V2 of the archive API calls fail
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. -
Go to link: http://localhost:1313/archives/. -
Click through links and make sure they match original site (https://docs.gitlab.com/archives/) links. -
Make sure the versions are in descending order and the code blocks for each version has url with the matching version. -
Error case: Please change one of the API endpoint URLs (either $DOCS_IMAGES_ENDPOINT_V1
or$DOCS_IMAGES_ENDPOINT_V2
) to something that doesn't exist and local should rebuild and show error banner at the end of the archives 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 #25 (closed)
Edited by Hiru Fernando