|
6 лет назад | |
---|---|---|
.. | ||
archetypes | 0a26c521f0 HDDS-487. Doc files are missing ASF license headers. Contributed by Namit Maheshwari. | 6 лет назад |
content | 35c7351f4b HDDS-455. Ozone genconf tool must use picocli. Contributed by Dinesh Chitlangia. | 6 лет назад |
dev-support | 43be9ab44f HDDS-89. Addendum Patch-1. Create ozone specific inline documentation as part of the build. | 7 лет назад |
static | 0a26c521f0 HDDS-487. Doc files are missing ASF license headers. Contributed by Namit Maheshwari. | 6 лет назад |
themes | 0a26c521f0 HDDS-487. Doc files are missing ASF license headers. Contributed by Namit Maheshwari. | 6 лет назад |
README.md | 0a26c521f0 HDDS-487. Doc files are missing ASF license headers. Contributed by Namit Maheshwari. | 6 лет назад |
config.yaml | 8af8453589 HDDS-435. Enhance the existing ozone documentation. | 6 лет назад |
pom.xml | 62f817d32e HDDS-447. Separate ozone-dist and hadoop-dist projects with real classpath separation. Contributed by Elek Marton. | 6 лет назад |
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"
---