readthedocs / readthedocs/ext-theme
Versions: consolidate version listing views
Open
@agjohnson is already working on this.
Since May 23, 2024.
Bug
Needed: design decision
- Dominant language
- HTML
- Stars
- 12
- Forks
- 6
- Avg merge
- 13h 25m
- Merged PRs (30d)
- 1
Description
There are two listing views for versions in the new dashboard, which are mostly identical:
- https://beta.readthedocs.org/projects/test-builds/ -- this is the main view, it is the first thing you see when clicking on a project
- https://beta.readthedocs.org/projects/test-builds/versions/ -- this is leftover from the legacy dashboard, where the main project view is a light version listing, and this is the full version listing
I see two options:
- Drop
/project/{slug}/versions/, use/project/{slug}URL as the view for listing versions - Make the default URL for projects
/project/{slug}/versions/instead of/project/{slug}/(which can go away, or redirect). This way the URL matches the active tab
We might wait for legacy dashboard to make this change. The two views should be mostly identical, however there might be a difference in the filters used.
- Redirect to the correct view on version form submission https://github.com/readthedocs/readthedocs.org/pull/11355
- Do away with
project.views.public.project_versions. This is a function based view that is missing a few features of the normal versions listing view. This view is redundant - Figure out what to do about the URL for this view
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Assessment
This issue has not been assessed yet.