opentofu.org icon indicating copy to clipboard operation
opentofu.org copied to clipboard

Documentation versioning

Open ghost opened this issue 1 year ago • 4 comments

Add documentation versioning to the website.

ghost avatar Jan 12 '24 12:01 ghost

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

IgnorantSapient avatar Jan 15 '24 21:01 IgnorantSapient

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?

ghost avatar Jan 15 '24 22:01 ghost

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

IgnorantSapient avatar Jan 16 '24 02:01 IgnorantSapient

Thank you @IgnorantSapient !

ghost avatar Jan 16 '24 07:01 ghost