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

Implement documentation versioning #8

Closed
Yantrio opened this issue Aug 30, 2023 · 2 comments
Closed

Implement documentation versioning #8

Yantrio opened this issue Aug 30, 2023 · 2 comments

Comments

@Yantrio
Copy link
Member

Yantrio commented Aug 30, 2023

Docusaurus supports documentation versioning out of the box, we should investigate the best approach for us to have here.

Initial thoughts are as follows:

  • Main branch of docs should be the "next" build (or preview, etc)
  • Version each set of documentation as we do a release, this should be automated in the long run.
  • Older versions of opentf docs should be kept where possible, so this effort needs to be introduced earlier rather than later.
@Yantrio Yantrio self-assigned this Aug 31, 2023
@Yantrio
Copy link
Member Author

Yantrio commented Aug 31, 2023

For now, we can use the https://docusaurus.io/docs/versioning setup manually.

However, I would like the documentation to be stable before we start implementing versioning.

My proposal for a versioning approach would be the 2nd approach listed here: https://docusaurus.io/docs/versioning#configuring-versioning-behavior

Tl;dr

  • Next version is the live docs from the main repo, this goes unpublished
  • Current version is the latest version that is released
  • Older versions are maintained and created with the cli tool when we do a release process

IMHO, it is not worth automating this right now as the process will happen so irregularly that we can handle it manually for now.

What we will need to think about in the future is how we can allow people to contribute to older versions of documentation and make sure that this is always an option (ie, to fix language spec docs)

@ghost
Copy link

ghost commented Jan 17, 2024

Closing in favor of #257 which already has an assignee.

@ghost ghost closed this as completed Jan 17, 2024
This issue was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants