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

Durable Links #67

Closed
hexsecs opened this issue Aug 15, 2023 · 6 comments · Fixed by #147
Closed

Durable Links #67

hexsecs opened this issue Aug 15, 2023 · 6 comments · Fixed by #147

Comments

@hexsecs
Copy link
Member

hexsecs commented Aug 15, 2023

Create durable links to the latest standard version and best practices version.

Currently the latest version doesn't have it's own durable links. For example the current version is 2.1.0 but we don't have durable links for it.

Page Link
Standard Latest (2.1.0) https://uptane.github.io/docs/standard/uptane-standard
Standard 2.1.0 https://uptane.github.io/docs/2.1.0/standard/uptane-standard <-- To be added
Standard 2.0.0 https://uptane.github.io/docs/2.0.0/standard/uptane-standard
.. ..
Best Practices (2.1.0) https://uptane.github.io/docs/deployment/best-practices
Best Practices 2.1.0 https://uptane.github.io/docs/2.1.0/deployment/best-practices <-- To be added
Best Practices 2.0.0 https://uptane.github.io/docs/2.0.0/deployment/best-practices

We need a way to reference the durable link to the standard (and best practices) of the latest version, so that a user can pin the version of the standard they want to reference INCLUDING whatever version is the latest.

What I expect to work is...
https://uptane.github.io/docs/standard/uptane-standard - points to whatever version is the latest. This content will change in the future, when a new version is released.
https://uptane.github.io/docs/2.1.0/standard/uptane-standard - points to a pinned version of 2.1.0.

@hexsecs
Copy link
Member Author

hexsecs commented Oct 11, 2023

The new website fixes this issue with the exception of the "latest" version. We will need to investigate how we can have both using docusaurus.

@Mikerniker
Copy link
Contributor

Hi @hexsecs, is this what you had in mind for the durable links:
new_versiondocusaurus
I'm not completely sure I understand, but let me know if this is the right direction, thank you

@hexsecs
Copy link
Member Author

hexsecs commented Nov 21, 2023

That looks a like a good automated way to do it. So we probably need to run yarn docusaurus docs:version 2.1.0 to make a static version of the current spec.

@Mikerniker
Copy link
Contributor

ok, can I try it out?

@hexsecs hexsecs assigned hexsecs and Mikerniker and unassigned hexsecs Nov 21, 2023
@hexsecs
Copy link
Member Author

hexsecs commented Nov 21, 2023

Sure. I assigned to you.

@Mikerniker
Copy link
Contributor

Ok, thanks @hexsecs

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.

2 participants