Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

After updating the docs configuration and pushing the new major release branch, as the last step you should also update the documentation build bot to also build the documentation for the new release branch. Check Managing Documentation on details on how to do that. You may also want to manually trigger a build to make the changes visible as soon as possible.

The rest of this guide assumes that commands are run in the root of a repository on the branch of the release version with the above environment variables set.

For major/minor releases add a link to the release documentation in docs/config.toml in the master branch.

...

Code Block
languagebash
PreviousDocs = [
    ["$SHORT_RELEASE_VERSION", "https://nightlies.apache.org/flink/flink-statefun-docs-release-$SHORT_RELEASE_VERSION"],
    ["3.1", "https://nightlies.apache.org/flink/flink-statefun-docs-release-3.1"],
    ["3.0", "https://nightlies.apache.org/flink/flink-statefun-docs-release-3.0"],
    ["2.2", "https://nightlies.apache.org/flink/flink-statefun-docs-release-2.2"]
  ]

The rest of this guide assumes that commands are run in the root of a repository on the branch of the release version with the above environment variables set.

Checklist to proceed to the next step

...