hadoop/hadoop-hdds/docs
2019-06-12 08:52:16 +02:00
..
archetypes
content Revert "HDDS-1659. Define the process to add proposal/design docs to the Ozone subproject (#922)" 2019-06-12 08:52:16 +02:00
dev-support/bin
static HDDS-1462. Fix content and format of Ozone documentation. Contributed by Elek, Marton. (#767) 2019-04-29 13:28:19 -07:00
themes/ozonedoc HDDS-1462. Fix content and format of Ozone documentation. Contributed by Elek, Marton. (#767) 2019-04-29 13:28:19 -07:00
config.yaml HDDS-846. Exports ozone metrics to prometheus. 2018-11-27 15:57:24 -08:00
pom.xml HADOOP-16331. Fix ASF License check in pom.xml 2019-05-29 17:25:13 +09:00
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"
---