Márton Elek f8aafe045e HDDS-602. bump the version to the next development version 6 years ago
..
archetypes a2fa8324d4 HDDS-832.Docs folder is missing from the Ozone distribution package. 6 years ago
content a2fa8324d4 HDDS-832.Docs folder is missing from the Ozone distribution package. 6 years ago
dev-support a2fa8324d4 HDDS-832.Docs folder is missing from the Ozone distribution package. 6 years ago
static a2fa8324d4 HDDS-832.Docs folder is missing from the Ozone distribution package. 6 years ago
themes a2fa8324d4 HDDS-832.Docs folder is missing from the Ozone distribution package. 6 years ago
README.md a2fa8324d4 HDDS-832.Docs folder is missing from the Ozone distribution package. 6 years ago
config.yaml a2fa8324d4 HDDS-832.Docs folder is missing from the Ozone distribution package. 6 years ago
pom.xml f8aafe045e HDDS-602. bump the version to the next development version 6 years ago

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"
---