|
5 år sedan | |
---|---|---|
.. | ||
archetypes | 9b01f039eb HDDS-832. Docs folder is missing from the Ozone distribution package. Contributed by Elek, Marton. | 6 år sedan |
content | 3e6a0166f4 HDDS-2051. Rat check failure in decommissioning.md (#1372) | 5 år sedan |
dev-support | 9b01f039eb HDDS-832. Docs folder is missing from the Ozone distribution package. Contributed by Elek, Marton. | 6 år sedan |
static | 68f53f95ad HDDS-1763. Use vendor neutral s3 logo in ozone doc. Contributed by Elek, Marton. | 5 år sedan |
themes | b4a95a2b00 HDDS-2000. Don't depend on bootstrap/jquery versions from hadoop-trunk snapshot | 5 år sedan |
README.md | 9b01f039eb HDDS-832. Docs folder is missing from the Ozone distribution package. Contributed by Elek, Marton. | 6 år sedan |
config.yaml | 9fd3c702fc HDDS-1639. Restructure documentation pages for better understanding | 5 år sedan |
pom.xml | d3fe993e60 HDDS-2023. Fix rat check failures in trunk (addendum) | 5 år sedan |
This subproject contains the inline documentation for Ozone/HDDS components.
You can create a new page with:
hugo new content/title.md
You can check the rendering with:
hugo serve
This maven project will create the rendered HTML page during the build (ONLY if hugo is available). And the dist project will include the documentation.
You can adjust the menu hierarchy with adjusting the header of the markdown file:
To show it in the main header add the menu entry:
---
menu: main
---
To show it as a subpage, you can set the parent. (The value could be the title of the parent page,
our you can defined an id: ...
in the parent markdown and use that in the parent reference.
---
menu:
main:
parent: "Getting started"
---