| commit | 97a42d6f3dddf94d013343929e2c21ecdd02f275 | [log] [tgz] |
|---|---|---|
| author | Andor Molnar <andor@cloudera.com> | Thu Mar 14 11:05:11 2024 -0500 |
| committer | Andor Molnar <andor@cloudera.com> | Thu Mar 14 11:05:11 2024 -0500 |
| tree | 916a76165a4eacca06a4c1a794be8b0ed8d07599 | |
| parent | d3a57bf2b06d941251b775b43e0422c5454c71cc [diff] |
CVE-2024-23944
In the src/main/resources/markdown directory you will find text files formatted using Markdown, with an .md suffix.
Building the site requires Maven 3.5.0 or newer. The easiest way to install Maven depends on your OS. The build process will create a directory called target/html containing index.html as well as the rest of the compiled directories and files. target should not be committed to git as it is generated content.
You can generate the static ZooKeeper website by running:
mvn clean install in this directory.cp -RP _released_docs target/html/doc - this will include the documentation (see “sub-dir” section below) in the generated site.At this point the contents of target are “staged” and can be reviewed prior to updating the ZooKeeper production website.
The product documentation creation is not part of the website generation process. They are built separately for each release of ZooKeeper from the ZooKeeper source repository.
Typically during a release the versioned documentation will be recreated and should be copied, and committed, under the _released_docs directory here.
git clone -b website https://gitbox.apache.org/repos/asf/zookeeper.gitmvn clean installcp -RP _released_docs target/html/doc These are the static release docs, not generated in this process.At this point verify that the generated files render properly (open target/html/index.html in a browser). If you are happy with the results move on to the next step, otherwise go to step 2 above.
git status should show modified files for the markdown that you changedgit add <the changed files>git commit -m "<appropriate commit message>"git push origin websiteThe source for the site is committed, now we need to push the generated files to the live site.
git checkout asf-siterm -fr contentmv target/html contentgit add contentVerify that content/index.html and other generated files are proper, e.g. open them in a browser
git status should show modified files for the markdown that you changedgit commit -m "<appropriate commit message>"git push origin asf-site