|
6 years ago | |
---|---|---|
.. | ||
archetypes | fac33c9628 HDDS-487. Doc files are missing ASF license headers. Contributed by Namit Maheshwari. | 6 years ago |
content | 9913b8d3d4 HDDS-483. Update ozone Documentation to fix below issues. | 6 years ago |
dev-support | 43be9ab44f HDDS-89. Addendum Patch-1. Create ozone specific inline documentation as part of the build. | 7 years ago |
static | fac33c9628 HDDS-487. Doc files are missing ASF license headers. Contributed by Namit Maheshwari. | 6 years ago |
themes | fac33c9628 HDDS-487. Doc files are missing ASF license headers. Contributed by Namit Maheshwari. | 6 years ago |
README.md | fac33c9628 HDDS-487. Doc files are missing ASF license headers. Contributed by Namit Maheshwari. | 6 years ago |
config.yaml | 13d4347cfd HDDS-435. Enhance the existing ozone documentation. | 6 years ago |
pom.xml | 6f7943c68e HDDS-495. Ozone docs and ozonefs packages have undefined hadoop component. Contributed by Dinesh Chitlangia. | 6 years ago |
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"
---