Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Spec website: How do we like the URL aliases to work? #1018

Closed
Tracked by #1094
bact opened this issue Aug 3, 2024 · 3 comments · Fixed by #1100
Closed
Tracked by #1094

Spec website: How do we like the URL aliases to work? #1018

bact opened this issue Aug 3, 2024 · 3 comments · Fixed by #1100
Milestone

Comments

@bact
Copy link
Collaborator

bact commented Aug 3, 2024

As it is difficult to explain for me, so I'm setting up a test website here for illustration.
(The test website is marked with "DRAFT (TEST-WEBSITE)" at the top and the bottom to avoid confusion)

We will use the URL of the test spec website https://bact.github.io/spdx-spec/
in place of
https://spdx.github.io/spdx-spec/ here for the purpose of discussion/demonstration.

Once 3.0.1 released, PR #1015 will made these following redirections:

1) Default redirection

If the user doesn't specify a version in the URL, we will bring them to the latest version:

https://bact.github.io/spdx-spec/ --> https://bact.github.io/spdx-spec/v3.0.1/

Do we like to have it like this?
(you can try clicking on these URLs)

https://spdx.github.io/spdx-spec/ currently redirects to https://spdx.github.io/spdx-spec/v3.0/

2) Alias

These following URLs will redirect to https://bact.github.io/spdx-spec/v3.0.1/ :

(Once we have 3.0.2, all of above will redirect instead to 3.0.2.
Once we have 3.1, "latest" will redirect to 3.1; but "v3.0*" will still redirect to the latest 3.0.x)

Do we like to have those URLs behave like that?

3) Versions available to choose from the UI

Only the latest patch versions for each minor version will be displayed on the dropdown list.

dropdown

Is this something we imagine?
Or do we also need v3.0 (v3.0.0) in the dropdown as well?

(for v2, we only have v2.3 and v2.2.2)


Feel free to suggest something else. Comments will inform changes to PR #1015. Thank you.

Note: Since, from the above settings, "v3.0" will be use as an alias, if we still like to get access to the original v3.0 (v3.0.0) content, we can apply PR #994 to republish v3.0 as v3.0.0.


Additional requirements

@kestewart
Copy link
Contributor

Discussed on the tech call, and asking the steering committee to advise.

@bact
Copy link
Collaborator Author

bact commented Aug 12, 2024

Related issue on redirections

@goneall
Copy link
Member

goneall commented Aug 27, 2024

Decision - 3.0 will redirect to the latest.

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

Successfully merging a pull request may close this issue.

3 participants