History

Xiaoyu Yao 9dd5d5ba71 HDDS-218. add existing docker-compose files to the ozone release artifact. Contributed by Elek Marton.		2018-08-17 07:58:24 -07:00
..
archetypes	HDDS-89. Create ozone specific inline documentation as part of the build.	2018-05-22 10:49:10 -07:00
content	HDDS-218. add existing docker-compose files to the ozone release artifact. Contributed by Elek Marton.	2018-08-17 07:58:24 -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-119. Skip Apache license header check for some ozone doc scripts. Contributed by Ajay Kumar.	2018-08-16 22:18:52 -07:00
themes/ozonedoc	HDDS-89. Create ozone specific inline documentation as part of the build.	2018-05-22 10:49:10 -07:00
README.md	HDDS-89. Create ozone specific inline documentation as part of the build.	2018-05-22 10:49:10 -07:00
config.toml	HDDS-89. Create ozone specific inline documentation as part of the build.	2018-05-22 10:49:10 -07:00
pom.xml	HDDS-119. Skip Apache license header check for some ozone doc scripts. Contributed by Ajay Kumar.	2018-08-16 22:18:52 -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"
---