Skip to content

Start versioning the platform docs as well #240

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

Closed
3 tasks done
fhennig opened this issue Jul 7, 2022 · 0 comments · Fixed by #266
Closed
3 tasks done

Start versioning the platform docs as well #240

fhennig opened this issue Jul 7, 2022 · 0 comments · Fixed by #266

Comments

@fhennig
Copy link
Contributor

fhennig commented Jul 7, 2022

At the moment the latest stable and current nightly docs for the platform docs have not diverged and it is okay to not have versions, but it should be versioned in the long term.

Like with the operators, it needs to have tags and versions at those tags. But there is no release script, so it can be adapted manually.

  • for the current docs, the version 22.06 needs to be put into the version key in the antora.yaml. This needs to be committed and tagged with docs/22.06
  • afterwards, another commit should set the version key to nightly and prerelease: true
  • in the antora-playbook.yaml the tags: docs/* needs to be added to the documentation repository, so the tagged versions are pulled in

Open question: Should there be an automated mechanism to release new versions? To release a new version, the version and prerelease keys in antora.yaml need to be adapted and the commit needs to be tagged. then a new commit needs to be made to set the version back to nightly and the prerelease to true. (This could be put into a script, possibly in the makefile?)

@fhennig fhennig moved this to Idea/Proposal in Stackable Engineering Sep 1, 2022
@lfrancke lfrancke moved this from Idea/Proposal to Waiting for Release in Stackable Engineering Sep 5, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

1 participant