THIS IS A TEST INSTANCE. ALL YOUR CHANGES WILL BE LOST!!!!
...
We should improve the release script to include these steps. In the meantime, for new releases:
- Make sure the docs/Verify that documentation.html (in kafka-site repo) is referring to the correct release and links.
- Verify that docs/documentation.html (in kafka repo) is similarly set up correctly.
- git clone https://git-wip-us.apache.org/repos/asf/kafka-site.git
- git checkout asf-site
- Update the website content including docs:
- The gradle target
releaseTarGz
generates the Kafka website content including the Kafka documentation (with the exception of a few pages like project-security.html, which are only tracked in the kafka-site repository). This build target also auto-generates the configuration docs of the Kafka broker/producer/consumer/etc. from their respective Java sources. The build output is stored in./core/build/distributions/kafka_2.13-2.8.0-site-docs.tgz
. - Untar the file and rename the
site-docs/
folder to28/
(or, if the latter already exists, replace its contents). That's because the docs for a release are stored in a separate folder (e.g.,27/
for Kafka v2.7 and28/
for Kafka v2.8), which ensures the Kafka website includes the documentation for the current and all past Kafka releases.
- The gradle target
- Update the javadocs:
- Create the release Javadocs with the gradle target
aggregatedJavadoc
, with output under./build/docs/javadoc/
. - Copy the
javadoc
folder to28/
(i.e., the full path is28/javadoc/
). If this is bug fix release, do this after the vote has passed to avoid showing an unreleased version number in the published javadocs.
- Create the release Javadocs with the gradle target
- Commit
...