Skip to content

Added archives pages with markdown and hugo template

Hiru Fernando requested to merge 25-archives-listing-page into main

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

Screenshot_2024-06-21_at_12.29.42_PM

This screenshot shows code blocks as well

Screenshot_2024-06-21_at_12.30.36_PM

Show error banner if V1 or V2 of the archive API calls fail

Screenshot_2024-06-22_at_11.07.37_AM

How to set up and validate locally

Numbered steps to set up and validate the change are strongly suggested.

  1. Configure a local GitLab Docs environment: https://gitlab.com/gitlab-org/technical-writing-group/gitlab-docs-hugo/-/blob/main/doc/setup.md.
  2. Go to link: http://localhost:1313/archives/.
  3. Click through links and make sure they match original site (https://docs.gitlab.com/archives/) links.
  4. Make sure the versions are in descending order and the code blocks for each version has url with the matching version.
  5. 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.

Closes #25 (closed)

Edited by Hiru Fernando

Merge request reports