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

[Feature]: Implement a working versioning of the website #80

Open
DaruZero opened this issue Mar 14, 2023 · 2 comments
Open

[Feature]: Implement a working versioning of the website #80

DaruZero opened this issue Mar 14, 2023 · 2 comments

Comments

@DaruZero
Copy link
Contributor

Describe your feature request for the documentation

Right now we don't have a proper way to host multiple versions of the website.

The idea would be to have a sub domain for each non-latest version of the umh, something like v0.9.10.umh.docs.umh.app.
The CloudFlare page should point to the related branch, e.g. release-0.9.10

The workflow should look something like this:

  • main branch with all the latest addition to the current version, hosted on umh.docs.umh.app
  • dev-0.9.12 branch where all the docs of new features / fixes for the next release of umh shall be merged
  • when new umh version gets released:
    • release-0.9.11 branch from main that will be the final version of the docs for umh v0.9.10, hosted on v0.9.10.umh.docs.umh.app
    • dev-0.9.12 shall be merged into main
    • dev-0.9.13 branched from main to be the target for new features

The config.toml file must be kept updated with the correct [[params.version]] sections

Describe possible alternatives

@JeremyTheocharis @Scarjit feel free to add suggestions on how to handle versioning

Additional Context

Kubernetes references:

@JeremyTheocharis
Copy link
Member

We have it and I already included an example for it. For each version, create a new branch with that version number. Then you can link the Cloudflare branch preview. See also:

https://github.com/united-manufacturing-hub/mgmt.docs.umh.app/blob/7ba69eca7414a35f77133d85c0d2030b2b1983d3/mgmt.docs.umh.app/config.toml#L88-L93

@DaruZero
Copy link
Contributor Author

So is this already functioning?

What's your opinion on the dev branching for future versions?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants