Page History

...

Note that directories containing an index.html file cannot be deleted; you first need to delete said file before deleting the directory.#

Manual upload

As an emergency measure it is possible to manually upload files to nightlies.apache.org, as explained in https://nightlies.apache.org/authoring.html.

...

# executed in docs/content
for i in $(find . -name "*.html" -type f); do
        x=$(echo $i | cut -c 3-)
        curl --netrc-file ~/nightlies -T $x https://nightlies.apache.org/flink/flink-docs-release-1.9/$x
done

net-rc-file contents: machine nightlies.apache.org login <username> password <password>

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.

Building legacy documentation

This section contains instructions for building the documentation of older Flink versions.

1.0 -> 1.7:

docs/build_docs.sh:

-bundle install --path .rubydeps
+bundle install --full-index --path .rubydeps

docker run --rm --volume="$PWD:/srv" --expose=4000 -p 4000:4000 -it ruby:2.3.1 bash -c "cd /srv && ./build_docs.sh"

1.8 -> 1.12:

docs/build_docs.sh:

docker run --rm --volume="$PWD:/srv" --expose=4000 -p 4000:4000 -it ruby:2.6.3 bash -c "cd /srv && ./build_docs.sh"