hadoop/hadoop-hdds/docs
Elek, Márton c7d426daf0 HDDS-1881. Design doc: decommissioning in Ozone (#1196)
* Address comments from Anu
 * In-flight calculation is removed from the base model
 * Throttling is mentioned but will be discussed in a separated document
 * Model is improved to handle the over-replication in a specific way
 (to handle Nanda's use-case)
 * Stop conditions are defined independently from the model
 * Style of the table fragments are improved
* typo fix (thx to sodonnell)
* remove white spaces from the end of the lines
* example is restored
* minor whitespace improvement to support pdf conversion
2019-08-28 10:19:03 -07:00
..
archetypes HDDS-832. Docs folder is missing from the Ozone distribution package. Contributed by Elek, Marton. 2018-11-15 11:08:48 +01:00
content HDDS-1881. Design doc: decommissioning in Ozone (#1196) 2019-08-28 10:19:03 -07:00
dev-support/bin HDDS-832. Docs folder is missing from the Ozone distribution package. Contributed by Elek, Marton. 2018-11-15 11:08:48 +01:00
static HDDS-1763. Use vendor neutral s3 logo in ozone doc. Contributed by Elek, Marton. 2019-07-04 17:14:19 +02:00
themes/ozonedoc HDDS-2000. Don't depend on bootstrap/jquery versions from hadoop-trunk snapshot 2019-08-23 10:56:00 +02:00
README.md HDDS-832. Docs folder is missing from the Ozone distribution package. Contributed by Elek, Marton. 2018-11-15 11:08:48 +01:00
config.yaml HDDS-1639. Restructure documentation pages for better understanding 2019-06-28 19:51:30 +02:00
pom.xml HDDS-2023. Fix rat check failures in trunk (addendum) 2019-08-23 12:31:42 +02: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"
---