search

opentofu / opentofu.org

The OpenTofu Website
https://opentofu.org/
Apache License 2.0
43 stars 20 forks source link

Documentation versioning #257

Open janosdebugs opened 6 months ago

janosdebugs commented 6 months ago

Add documentation versioning to the website.

IgnorantSapient commented 6 months ago

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

janosdebugs commented 6 months ago

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 commented 6 months ago

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

janosdebugs commented 6 months ago

Thank you @IgnorantSapient !