o3de.org
o3de.org copied to clipboard
RFC - O3DE Docs Version Picker/Dropdown Centralization
Describe the feature you'd like available on the website
I was thinking that perhaps the version picker could be decoupled from the repo versions and held in some sort of "current" location that only needs to update once and have all the previous versions simply pull the list from there.
It would allow for one PR to change the picker list, which would then propagate to all the docs versions.
Proposed implementation
From an immediate glance it would require one last PR wave through all the previous versions to build whatever functionality it would need to draw from a non-local destination.
The new resting place of it would need to remain as a single point of contact, not something that ends up passing through the future versions and breaks back into different "current" locations.
And would ultimately require a refactor to what is being done for that version picker, as the code required to pull it in from somewhere would definitely necessitate different logic. Of course that would also allow for a redesign over how the picker names, redirects, etc. Which could allow for a much smoother, more intuitive updating process.
Available alternatives
Original Functionality The current method of updating the version dropdown requires needing to go through every docs version repo and do a manual update to the list and submit a PR that requires approvals and mergers.
It's prone to errors, inconsistencies, and flat out missing repos. And the functionality of the dropdown itself is quite unintuitive.
Generative Local List A concept from @ShaunaGordon: "Pull straight from Github and just pull the branches and pay attention to the version/* ones, sorting them by version value, and populating the picker with that. However, I don't know offhand if I can get that information without authentication (and auth via JS kind of defeats security stuff). It's something that was kind of on my mental todo list for when I propose refactoring version management overall."
Supplements
Unfortunately I am not particularly clear on how the website works to use the dropdown listing files, or how one would go about centralizing the picker alone and then drawing it into the docs pages. Certain things would definitely need a refactor.