|
6 years ago | |
---|---|---|
.. | ||
archetypes | 9b01f039eb HDDS-832. Docs folder is missing from the Ozone distribution package. Contributed by Elek, Marton. | 6 years ago |
content | 7ec6a31eb3 HDDS-1333. OzoneFileSystem can't work with spark/hadoop2.7 because incompatible security classes. Contributed by Elek, Marton. (#653) | 6 years ago |
dev-support | 9b01f039eb HDDS-832. Docs folder is missing from the Ozone distribution package. Contributed by Elek, Marton. | 6 years ago |
static | dea2c1b485 HDDS-951. Replace the source url of Ozone logo. Contributed by Takanobu Asanuma. | 6 years ago |
themes | 9b01f039eb HDDS-832. Docs folder is missing from the Ozone distribution package. Contributed by Elek, Marton. | 6 years ago |
README.md | 9b01f039eb HDDS-832. Docs folder is missing from the Ozone distribution package. Contributed by Elek, Marton. | 6 years ago |
config.yaml | 34a914be03 HDDS-846. Exports ozone metrics to prometheus. | 6 years ago |
pom.xml | 1b87668a3b HDDS-1165. Document generation in maven should be configured on execution level. Contributed by Anu Engineer. | 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"
---