The Flink(-StateFun) documentation is build nightly in the Apache buildbot (https://ci2.apache.org/) environment and served by it as well. The content is pushed to nightlies.apache.org/flink.
Build Environment
Apache Buildbot
...
The configuration files above mentioned above contains contain a flink*_branches_nightly variable that configures the branches to build nightly:
...
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
Builder status
For Flink, you can check the progress of the build at, for example, https://ci2.apache.org/#/builders/17/builds/1.
...
You can check the progress of all builders at https://ci2.apache.org/#/builders.
Cleaning up content
See https://nightlies.apache.org/authoring.html for instructions on how to delete content from nightlies.apache.org
.
Note that directories containing an index.html
file cannot be deleted; you first need to delete said file before deleting the directory.
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.
Neither of these will push any content to nightlies.apache.org
.