Márton Elek c7f349bc3f HDDS-703. Ozone docs does not render correctly on a Mobile Device. Contributed by Elek, Marton. 6 年之前
..
archetypes 0a26c521f0 HDDS-487. Doc files are missing ASF license headers. Contributed by Namit Maheshwari. 6 年之前
content c456d6b3a5 HDDS-621. ozone genconf improvements. Contributed by Dinesh Chitlangia. 6 年之前
dev-support 43be9ab44f HDDS-89. Addendum Patch-1. Create ozone specific inline documentation as part of the build. 7 年之前
static 0a26c521f0 HDDS-487. Doc files are missing ASF license headers. Contributed by Namit Maheshwari. 6 年之前
themes c7f349bc3f HDDS-703. Ozone docs does not render correctly on a Mobile Device. Contributed by Elek, Marton. 6 年之前
README.md 0a26c521f0 HDDS-487. Doc files are missing ASF license headers. Contributed by Namit Maheshwari. 6 年之前
config.yaml 8af8453589 HDDS-435. Enhance the existing ozone documentation. 6 年之前
pom.xml 600438bcde HDDS-602. Bump Ozone version to 0.4.0-SNAPSHOT after ozone-0.3 branch cut. 6 年之前

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"
---