hadoop/hadoop-ozone/docs
Anu Engineer 8af8453589 HDDS-435. Enhance the existing ozone documentation.
Contributed by Elek, Marton.
2018-09-17 10:46:28 -07:00
..
archetypes
content HDDS-435. Enhance the existing ozone documentation. 2018-09-17 10:46:28 -07:00
dev-support/bin HDDS-89. Addendum Patch-1. Create ozone specific inline documentation as part of the build. 2018-05-22 14:29:06 -07:00
static HDDS-333. Create an Ozone Logo. Contributed by Priyanka Nagwekar. 2018-09-05 14:31:36 +02:00
themes/ozonedoc HDDS-435. Enhance the existing ozone documentation. 2018-09-17 10:46:28 -07:00
README.md
config.yaml HDDS-435. Enhance the existing ozone documentation. 2018-09-17 10:46:28 -07:00
pom.xml HDDS-435. Enhance the existing ozone documentation. 2018-09-17 10:46:28 -07: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"
---