Versions Compared

Old Version 5

changes.mady.by.user Till Rohrmann

Saved on

compared with

New Version 6

changes.mady.by.user Till Rohrmann

Saved on

Key

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

...

Next, for major releases, some configuration for our documentation builds needs to be manually updated, in the docs/_config.ymltoml file:, as listed below.


Code Block
languagebash
version: baseURL = '//nightlies.apache.org/flink/flink-statefun-docs-release-$SHORT_RELEASE_VERSION'
IsStable = true
Version = "$RELEASE_VERSION
version_title: "
VersionTitle = "$SHORT_RELEASE_VERSION
github_branch: "
Branch = "release-$SHORT_RELEASE_VERSION
baseurl: //ci.apache.org/projects/flink/flink-statefun-docs-release-$SHORT_RELEASE_VERSION
javadocs_baseurl: //ci"
MenuLinks = [
    ["Project Homepage", "//flink.apache.org"],
    ["JavaDocs", "//nightlies.apache.org/projects/flink/flink-statefun-docs-release-$SHORT_RELEASE_VERSION
is_stable: true/api/java/"],
  ]


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.

...