Versions Compared

Key

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

The Flink and Flink Stateful Functions documentation is build nightly in the Apache buildbot (https://ci.apache.org/buildbot.html) environment and served by it as well.

The StateFun documentation is built nightly and served at https://ci2.apache.org/.

Build Environment

Apache Buildbot

...

Branch configuration

The configuration files above mentioned above contains a flink*_branches_nightly variable that configures the branches to build nightly:

...

The StateFun docs will be served under the following URLs:

  • https://cinightlies.apache.org/projects/flink/flink-statefun-docs-BRANCH (e.g. flink-statefun-docs-master)
  • https://cinightlies.apache.org/projects/flink/flink-statefun-docs-ALIAS (e.g. flink-statefun-docs-stable)

...

You can manually trigger a build via an IRC buildbot.

  1. Go For Flink, go to: https://webchat.freenode.net/. For StateFun, go to: https://web.libera.chat/
  2. Pick a nickname (e.g. uce) and channel #flink-testing
  3. For Flink docs, type flink-buildbot: force build flink-docs-release-1.5BRANCH
  4. For StateFun docs, type flink-statefunsf-buildbot: force build flink-statefun-docs-release-2.0BRANCH

The command in the 3rd step will force build the docs of the provided builder, e.g. flink-docs-release-1.5 or flink-statefun-docs-release-2.0 in the above example.

[09:56] == uce [02cd5693@gateway/web/freenode/ip.2.205.86.147] has joined #flink-testing
[09:57] <uce> flink-buildbot: force build flink-docs-release-1.5
[09:57] <@flink-buildbot> build #7 forced
[09:57] <@flink-buildbot> I'll give a shout when the build finishes

You For Flink, you can check the progress of the build at https://ci.apache.org/builders/flink-docs-release-1.5/builds/7 where the last number is the build number. You can check the progress of all builders at https://ci.apache.org/builders.

For StateFun, you can check the progress of the build at, for example, https://ci2.apache.org/#/builders/14/builds/43. You can check the progress of all builders at https://ci2.apache.org/#/builders.

Testing changes

Changes to the website build process can be tested by pushing to the docs_experimental__docs  and docs_experimental__docs_compile  branches (of the Flink repository) and triggering a manual build. The first branch will only run build_docs.sh , while the latter will also compile Flink and generate the java/scala/python docs.

...