HDDS-5121. Add documentation for 1.1.0 release. (#5)

2 files changed
tree: e16b3fe33319f88e35611f6cd6a6a708c2679f99
  1. .asf.yaml
  2. .github/
  3. .gitignore
  4. LICENSE.txt
  5. README.md
  6. build.sh
  7. config.toml
  8. content/
  9. layouts/
  10. static/
README.md

Apache Ozone web page

This is the source code of the website of Apache Ozone.

To render it you need hugo static site generator (https://gohugo.io/getting-started/installing) which is available for the most popular platforms as a single binary.

To check the rendered website use the following command (and check the temporary, rendered version at ./public):

hugo

To develop the site use

hugo serve

which starts an internal server where you can always check the final rendered version.

Update ozone.apache.org

For modify the content the Ozone site the rendered version should be committed to the asf-site branch.

This is handled by a Github Action which refresh the rendered branch and commit the changes: It's enough to modify the source files on this branch, no other action is required. Updating the Hugo source files on this branch will automatically update the site itself.

Publishing the asf-site branch as the https://ozone.apache.org is configured by the .asf.yaml descriptor.