hadoop/hadoop-ozone/docs
Yiqun Lin 54a229c332 HDDS-628. Fix outdated names used in HDDS documentations.
(cherry picked from commit 5da042227c)
2018-10-12 14:01:47 +08:00
..
archetypes HDDS-487. Doc files are missing ASF license headers. Contributed by Namit Maheshwari. 2018-09-17 16:21:10 -07:00
content HDDS-628. Fix outdated names used in HDDS documentations. 2018-10-12 14:01:47 +08: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-487. Doc files are missing ASF license headers. Contributed by Namit Maheshwari. 2018-09-17 16:21:10 -07:00
themes/ozonedoc HDDS-487. Doc files are missing ASF license headers. Contributed by Namit Maheshwari. 2018-09-17 16:21:10 -07:00
README.md HDDS-487. Doc files are missing ASF license headers. Contributed by Namit Maheshwari. 2018-09-17 16:21:10 -07:00
config.yaml HDDS-435. Enhance the existing ozone documentation. 2018-09-17 10:46:28 -07:00
pom.xml HDDS-447. Separate ozone-dist and hadoop-dist projects with real classpath separation. Contributed by Elek Marton. 2018-09-24 10:10:11 -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"
---