Home Explore Help
Register Sign In
apache
/
hadoop
mirror of https://github.com/apache/hadoop.git
2
0
Fork 1
Files Issues 0 Wiki
Tree: fdf5a3fd63
Branches Tags
hadoop
/
hadoop-ozone
/
docs
Arpit Agarwal 82fbbd546c HDDS-469. Rename 'ozone oz' to 'ozone sh'. Contributed by Arpit Agarwal. 6 years ago
..
archetypes 481bfdb94f HDDS-89. Create ozone specific inline documentation as part of the build. 7 years ago
content 82fbbd546c HDDS-469. Rename 'ozone oz' to 'ozone sh'. Contributed by Arpit Agarwal. 6 years ago
dev-support 43be9ab44f HDDS-89. Addendum Patch-1. Create ozone specific inline documentation as part of the build. 7 years ago
static 045270a679 HDDS-333. Create an Ozone Logo. Contributed by Priyanka Nagwekar. 6 years ago
themes 481bfdb94f HDDS-89. Create ozone specific inline documentation as part of the build. 7 years ago
README.md 481bfdb94f HDDS-89. Create ozone specific inline documentation as part of the build. 7 years ago
config.toml 481bfdb94f HDDS-89. Create ozone specific inline documentation as part of the build. 7 years ago
pom.xml 94ed5cffd7 HDDS-214. Bump ozone/hdds version after the release branch cut 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"
---