Ajay Kumar 9d3a22ebc0 Revert "HDDS-973. HDDS/Ozone fail to build on Windows." 6 years ago
..
archetypes 9b01f039eb HDDS-832. Docs folder is missing from the Ozone distribution package. Contributed by Elek, Marton. 6 years ago
content be269feb6a HDDS-1462. Fix content and format of Ozone documentation. Contributed by Elek, Marton. (#767) 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 be269feb6a HDDS-1462. Fix content and format of Ozone documentation. Contributed by Elek, Marton. (#767) 6 years ago
themes be269feb6a HDDS-1462. Fix content and format of Ozone documentation. Contributed by Elek, Marton. (#767) 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 9d3a22ebc0 Revert "HDDS-973. HDDS/Ozone fail to build on Windows." 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"
---