50a22b66c0
* HDDS-1659. Define the process to add proposal/design docs to the Ozone subproject
* Remove Site improvements to display proposals
* adding license header
* clarify the support of the existing method
|
||
|---|---|---|
| .. | ||
| archetypes | ||
| content | ||
| dev-support/bin | ||
| static | ||
| themes/ozonedoc | ||
| README.md | ||
| config.yaml | ||
| pom.xml | ||
README.md
Hadoop Ozone/HDDS docs
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"
---