Managing Flink Documentation

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

Build Environment

Apache Buildbot

The file flink.conf configures buildbot for checking out Flink branches and building the docs. Check it out for adjusting the build configuration.

• flink.conf: https://svn.apache.org/repos/infra/infrastructure/buildbot/aegis/buildmaster/master1/projects/flink.conf

Branch configuration

The flink.conf file mentioned above contains a flink_branches_nightly variable that configures the branches to build nightly:

# format: (branch, alias) or branch
flink_branches_nightly = [
 ('master', 'release-1.6'),
 ('release-1.5', 'stable'),
 'release-1.4',
 'release-1.3',
 'release-1.2',
 'release-1.1',
 'release-1.0'
]

The docs will be served under the following URLs:

• https://ci.apache.org/projects/flink/flink-docs-BRANCH (e.g. flink-docsmaster)
• https://ci.apache.org/projects/flink/flink-docs-ALIAS (e.g. flink-docs-release-1.6)

Triggering a build manually

You can manually trigger a build via an IRC buildbot.

1. Go to: https://webchat.freenode.net/
2. Pick a nickname (e.g. uce) and channel #flink-testing
3. Type flink-buildbot: force build flink-docs-release-1.5 build me the docs please

The command in the 3rd step will force build the docs of the provided builder, e.g. flink-docs-release-1.5 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 build me the docs please
[09:57] <@flink-buildbot> build #7 forced
[09:57] <@flink-buildbot> I'll give a shout when the build finishes

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.