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

Documentation versioning #257

Open
ghost opened this issue Jan 12, 2024 · 4 comments
Open

Documentation versioning #257

ghost opened this issue Jan 12, 2024 · 4 comments
Assignees
Labels
accepted Issues accepted for implementation enhancement New feature or request good first issue Good for newcomers

Comments

@ghost
Copy link

ghost commented Jan 12, 2024

Add documentation versioning to the website.

@ghost ghost added good first issue Good for newcomers accepted Issues accepted for implementation enhancement New feature or request labels Jan 12, 2024
@IgnorantSapient
Copy link
Contributor

Willing to take this on, but need a bit more context and guidance on what we wish to achieve.

How do we want the versioning to be structured. Now the URLS are like https://opentofu.org/docs/cli/commands/apply do we want it all to be changed to https://opentofu.org/docs/1.6/cli/commands/apply (need to think about SEO implications of this)

or do we just try and mirror whatever Hashicorp has done with their docs for consistency?

image

@ghost
Copy link
Author

ghost commented Jan 15, 2024

Hey @IgnorantSapient thank you for your continued contributions. As far as the SEO implications are concerned, I believe it would be good if the latest version would always be at a consistent URL and older versions would be addresseable with their version number in the URL. However, I have no idea if this is something that's possible with Docusaurus correctly.

This will become relevant when 1.7.0 is nearing release, but it wouldn't hurt to have docs for the current main branch (next unreleased version) either. If you're up for it, we'd be very happy for your contribution as there's currently nobody working on this. Should I assign you to the issue?

@IgnorantSapient
Copy link
Contributor

@janosdebugs Please do assign it to me, I will get a branch going.....

@ghost ghost assigned IgnorantSapient Jan 16, 2024
@ghost
Copy link
Author

ghost commented Jan 16, 2024

Thank you @IgnorantSapient !

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
accepted Issues accepted for implementation enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

1 participant