Startseite Erkunden Hilfe
Registrieren Anmelden
apache
/
hadoop
Mirror von https://github.com/apache/hadoop.git
2
0
Fork 1
Dateien Issues 0 Wiki
Branch: HDFS-13532
Branches Tags
hadoop
/
hadoop-ozone
/
docs
Bharat Viswanadham 6668c19daf HDDS-677. Create documentation for s3 gateway to the docs. Contributed by Elek Marton. vor 6 Jahren
..
archetypes 0a26c521f0 HDDS-487. Doc files are missing ASF license headers. Contributed by Namit Maheshwari. vor 6 Jahren
content 6668c19daf HDDS-677. Create documentation for s3 gateway to the docs. Contributed by Elek Marton. vor 6 Jahren
dev-support 43be9ab44f HDDS-89. Addendum Patch-1. Create ozone specific inline documentation as part of the build. vor 7 Jahren
static 0a26c521f0 HDDS-487. Doc files are missing ASF license headers. Contributed by Namit Maheshwari. vor 6 Jahren
themes c7f349bc3f HDDS-703. Ozone docs does not render correctly on a Mobile Device. Contributed by Elek, Marton. vor 6 Jahren
README.md 0a26c521f0 HDDS-487. Doc files are missing ASF license headers. Contributed by Namit Maheshwari. vor 6 Jahren
config.yaml 8af8453589 HDDS-435. Enhance the existing ozone documentation. vor 6 Jahren
pom.xml 600438bcde HDDS-602. Bump Ozone version to 0.4.0-SNAPSHOT after ozone-0.3 branch cut. vor 6 Jahren

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