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

No easy way to provide link to versioned 1.1 Hydra docs #1871

Closed
Jasha10 opened this issue Oct 29, 2021 · 2 comments · Fixed by #2321
Closed

No easy way to provide link to versioned 1.1 Hydra docs #1871

Jasha10 opened this issue Oct 29, 2021 · 2 comments · Fixed by #2321
Labels
enhancement Enhanvement request

Comments

@Jasha10
Copy link
Collaborator

Jasha10 commented Oct 29, 2021

It is easy to provide a link to the Hydra docs at version 1.0, e.g. https://hydra.cc/docs/1.0/intro.

When providing links to pages of the version 1.1, however, the version number does not appear in the url, e.g. https://hydra.cc/docs/intro.

When providing such links in e.g. answers to user questions, I fear that the links will become outdated. It would be nice if our website had a way to provide a versioned link for the latest stable version.

@Jasha10 Jasha10 added the enhancement Enhanvement request label Oct 29, 2021
@omry
Copy link
Collaborator

omry commented Oct 30, 2021

Since 1.1 docs are done, it's a good time to tag a docusaurus version for it. This will enable such links and ensure doc changes are not changing the 1.1 docs.

@Jasha10
Copy link
Collaborator Author

Jasha10 commented Nov 4, 2021

it's a good time to tag a docusaurus version for it.

I've been having trouble with this in PR #1877. We already have versioned docs for v1.1 (i.e. website/versions.json has a version 1.1, and website/versioned_docs/version-1.1 exists with a frozen copy of the docs).

The problem is that there's no way to get a permalink to the v1.1 docs.
According to the table from the docusaurus docs here, this seems to be expected:

Path Version URL
versioned_docs/version-1.0.0/hello.md 1.0.0 /docs/1.0.0/hello
versioned_docs/version-1.1.0/hello.md 1.1.0 (latest) /docs/hello
docs/hello.md current /docs/next/hello

See that the URL for the latest docs version is /docs/hello, and does not contain a version number. In other words, there seems to be no way to make a permalink to our v1.1 docs until after the v1.2 docs have been pinned.

This seems to be related to docusaurus issues filed here and here.

@Jasha10 Jasha10 added the blocked Can't make progress label Nov 4, 2021
@Jasha10 Jasha10 removed the blocked Can't make progress label Jul 29, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Enhanvement request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants