|
5 år sedan | |
---|---|---|
.. | ||
archetypes | 9b01f039eb HDDS-832. Docs folder is missing from the Ozone distribution package. Contributed by Elek, Marton. | 6 år sedan |
content | 50a22b66c0 HDDS-1659. Define the process to add proposal/design docs to the Ozone subproject (#950) | 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 | 9fd3c702fc HDDS-1639. Restructure documentation pages for better understanding | 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 | afd844059c HADOOP-16331. Fix ASF License check in pom.xml | 6 å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"
---