Skip to content

Conversation

@will-sh
Copy link

@will-sh will-sh commented Apr 2, 2025

What changes were proposed in this pull request?

HDDS-9616. Add downloads page

Please describe your PR in detail:

  • What changes are proposed in the PR and why? It would be better if it is written from third person's perspective not just for the reviewer.
  • Added downloads page to reflect the same as the current site.
  • Added a placeholder for the current release 1.4.1 in release-notes/

What is the link to the Apache Jira?

HDDS-9616. Add downloads page

How was this patch tested?

Check off which of the following tests were done on this change. If additional testing was done, please elaborate here as well.

  • The CI checks on my fork are passing
  • I verified the rendered content using a local preview
  • I manually verified the steps provided in this change work as described

@github-actions github-actions bot added the website-v2 Tasks for the new ozone website targeting the HDDS-9225-website-v2 branch label Apr 2, 2025
@kerneltime
Copy link
Contributor

Release note pages are 404. Not sure if you intended to add them.

@will-sh
Copy link
Author

will-sh commented Apr 2, 2025

hi @kerneltime

Release note pages are 404. Not sure if you intended to add them.

Do you mean the http://localhost:3001/release-notes endpoint?
Currently we don't have a release-notes endpoint in the website-v2
In this PR I just added release-notes/1.4.1.md, which is just a placeholder, we can improve the release notes-related pages in HDDS-9617

@will-sh
Copy link
Author

will-sh commented Apr 8, 2025

Headers have been added to the release notes to indicate that they are no longer maintained.
The following metadata was added to the .md file headers and is dynamically loaded via JavaScript:

---
supported_version: false
release_date: "2020 Sep 02"
---

The logic has been implemented to:

  • Display supported versions in the first table
  • Show archived versions in the second and third tables

The release notes remain in the same directory, no changes were made to the folder structure.
Only the .md files need to be maintained going forward, as the JavaScript handles them dynamically.

@ivandika3 ivandika3 requested review from ivandika3 and kerneltime July 7, 2025 03:58
Copy link

@ivandika3 ivandika3 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the download page. Overall LGTM.

Just need to add download links for 2.0.0 and I think we're good to go. The release notes can be handled under HDDS-9617.

Copy link
Contributor

@errose28 errose28 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Coming from my original comment on the Jira I'm still not seeing what we gain by having this metadata in the front matter instead of just linking the pages in the correct part of the table.

The supported version information and release date should be displayed in the table, and on the actual release page itself. If there's a way to automate both of these from the front matter then maybe this is the way to go. But if the information still needs to be duplicated in the rendered markdown of each release page then we are still tracking it in two places.

If we do have some sort of automation, we should embed the javascript in download.mdx instead of making it all javascript. mdx will allow us to only automate the necessary parts while leaving the plain text around it easily editable as markdown.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

website-v2 Tasks for the new ozone website targeting the HDDS-9225-website-v2 branch

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants