Restructure the download page #2011
Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR restructures the Downloads section by splitting it into separate pages for the current release and past releases, and updates the site menu to surface these new pages.
- Updated
hugo.yamlto nest "Releases" and "Release Archive" under Downloads and removed the old single Downloads page - Added three new content files under
site/content/downloads/(_index.md,current-release.md,past-releases.md) - Deleted the legacy
site/content/downloads.md
Reviewed Changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| site/hugo.yaml | Reorganized main menu: removed old Downloads entry, added sub‐items |
| site/content/downloads/_index.md | New Downloads section index |
| site/content/downloads/current-release.md | New page for the current release |
| site/content/downloads/past-releases.md | New page listing past releases |
| site/content/downloads.md | Removed legacy downloads page |
Comments suppressed due to low confidence (3)
site/hugo.yaml:112
- The 'Downloads' menu item no longer has an explicit url, which may break navigation; consider re-adding
url: "/downloads"to maintain correct linking.
- name: "Downloads"
site/hugo.yaml:156
- This new 'GitHub' menu entry under community is missing a
parent: "community"attribute, so it may appear as a top-level link. Add the parent to group it correctly.
- name: "GitHub"
site/content/downloads/past-releases.md:27
- Consider adding the
KEYSfile link in the Downloads column here to match the entries on the current release page.
| **0.9.0** | 3/11/2024 | [tar.gz](https://downloads.apache.org/incubator/polaris/0.9.0-incubating/apache-polaris-0.9.0-incubating.tar.gz) • [asc](https://downloads.apache.org/incubator/polaris/0.9.0-incubating/apache-polaris-0.9.0-incubating.tar.gz.asc) • [sha512](https://downloads.apache.org/incubator/polaris/0.9.0-incubating/apache-polaris-0.9.0-incubating.tar.gz.sha512) | [Notes](#0.9.0) |
| - name: GitHub | ||
| url: https://github.com/apache/polaris | ||
|
|
There was a problem hiding this comment.
This change makes "github" menu a bit nicer, there is no extra space now.
| linkTitle: "Current Release" | ||
| weight: 100 | ||
| --- | ||
|
|
||
| ### Apache Polaris 0.9.0 |
There was a problem hiding this comment.
With this require manually moving "previous" entries to the "past releases" page on every release?
I understand we have to edit this page on every release, but adding entries on top is generally easier that copy-paste across pages 🤔
There was a problem hiding this comment.
How about a page per version? "Current" could be a link to the latest version page... WDYT?
There was a problem hiding this comment.
yeah, it requires a copy-over. I think the current release page is pretty light at this moment, but overtime, there are more things to add, docker image, helm chart instruction, etc. Or any general comments and instructions could be in that page as the index page of the releases. In that case, putting all release notes there wouldn't be easy to discover.
This is just my first version. I'm nowhere an UI expert. Feel free to change that.
There was a problem hiding this comment.
A page per version is also a solution. Spark did that but only for release notes, https://spark.apache.org/releases/spark-release-4-0-0.html.
There was a problem hiding this comment.
Sorry for confusing. It actually doesn't require a copy-over action. Every time we got a new release, the past releases page will have all of them including the latest one. Only the current release page needs to change.
There was a problem hiding this comment.
I'm not a Hugo expert myself, but if we can get links / redirects to work then user should still be able to bookmark the generic "downloads" URL and get the latest release in the browser.
There was a problem hiding this comment.
I didn't quite get it. How about this? merging this, first then you can file a PR to include your ideas on top of it. This way, we can iterate faster.
There was a problem hiding this comment.
My comments are non-blocking. Let's see what other reviews think.
There was a problem hiding this comment.
Consolidated them into a single page.
There was a problem hiding this comment.
@flyrain just unified the current release and past release page, so we just need to update one page on every release, which seems making things simplier
| - [Source (tar.gz)](https://downloads.apache.org/incubator/polaris/0.9.0-incubating/apache-polaris-0.9.0-incubating.tar.gz) | ||
| - [PGP Signature (.asc)](https://downloads.apache.org/incubator/polaris/0.9.0-incubating/apache-polaris-0.9.0-incubating.tar.gz.asc) | ||
| - [SHA512 Checksum](https://downloads.apache.org/incubator/polaris/0.9.0-incubating/apache-polaris-0.9.0-incubating.tar.gz.sha512) | ||
| - [KEYS File](https://downloads.apache.org/incubator/polaris/KEYS) |
There was a problem hiding this comment.
should this be 1.0? it seems we have both previous and current release that are 0.9? or we are going to change this in a different PR?
There was a problem hiding this comment.
1.0 isn't ready yet -- I will add it once it is approved. The past releases page will include all releases including the current release.
github-project-automation
bot
moved this from PRs In Progress
to Ready to merge
in Basic Kanban Board
|
@flyrain you might want to update the description since it doesn't match what this PR is actually doing now |
any suggestion for the description? |
|
I see you updated the description with just one release page now, that should be good enough |
github-project-automation
bot
moved this from Ready to merge
to Done
in Basic Kanban Board
Before:
After: