Work in progress

src/reference/.gitignore

@@ -1,3 +1,3 @@
-modules/ROOT/nav.adoc
-modules/ROOT/pages/_partials/dyn/
-modules/ROOT/assets/images/graphviz/
+modules/*/nav.adoc
+modules/*/pages/_partials/dyn/
+modules/*/assets/images/graphviz/

src/reference/Makefile

@@ -1,13 +1,16 @@
 ## Rudder User Documentation Makefile
 
-.PHONY: clean $(ADOC_DYN_FILES)
+.PHONY: clean $(ADOC_DYN_FILES) modules/ROOT/nav.adoc
 
-ADOC_SRC_FILES = $(shell find modules/ROOT/ -type f -name '*.adoc')
+ADOC_SRC_FILES = $(shell find modules/ROOT/pages -type f -name '*.adoc')
 ADOC_DYN_FILES = generic_methods.adoc hooks.adoc rudder.adoc
 GRAPHVIZ_FILES = $(shell find modules/ROOT/assets/graphviz -type f -name '*.dot')
 GRAPHVIZ_IMAGES = $(addprefix modules/ROOT/assets/images/graphviz/, $(notdir $(GRAPHVIZ_FILES:dot=png)))
 
+MODULES = ROOT installation
+
 content: $(GRAPHVIZ_IMAGES) $(ADOC_DYN_FILES) modules/ROOT/nav.adoc
+## nav.adoc
 
 ## Dynamic content
 
@@ -17,7 +20,8 @@ content: $(GRAPHVIZ_IMAGES) $(ADOC_DYN_FILES) modules/ROOT/nav.adoc
 	cp dependencies/$@ modules/ROOT/pages/_partials/dyn/$@
 
 modules/ROOT/nav.adoc: $(ADOC_SRC_FILES)
-	./tools/generate-nav.py > modules/ROOT/nav.adoc
+	./tools/generate-nav.py ROOT "Introduction" > modules/ROOT/nav.adoc
+	./tools/generate-nav.py installation "Installation" > modules/installation/nav.adoc
 
 modules/ROOT/assets/images/graphviz/%.png: modules/ROOT/assets/graphviz/%.dot
 	mkdir -p modules/ROOT/assets/images/graphviz

src/reference/antora.yml

@@ -3,4 +3,9 @@ title: Reference manual
 version: "5.0"
 nav:
 - modules/ROOT/nav.adoc
+- modules/installation/nav.adoc
+- modules/usage/nav.adoc
+- modules/administration/nav.adoc
+- modules/plugins/nav.adoc
+- modules/reference/nav.adoc
 

src/reference/modules/ROOT/pages/00_introduction/01_presentation.adoc → src/reference/modules/ROOT/pages/01_presentation.adoc

@@ -1,15 +1,13 @@
-== Introduction
-
 [[what-is-rudder]]
-=== What is Rudder?
+= What is Rudder?
 
 image::big-rudder-logo.png["Rudder logo", align="center"]
 
 Rudder is an easy to use, web-driven, role-based solution for IT Infrastructure
 Automation and Compliance. With a focus on continuously checking configurations
 and centralising real-time status data, Rudder can show a high-level summary
 (_ISO 27001 rules are at 100%!_) and break down noncompliance issues to a deep
-technical level (_Host prod-web-03: SSH server configuration allows root logins_).
+technical level (_Host prod-web-03: SSH server configuration allows root login_).
 
 A few things that make Rudder stand out:
 
@@ -32,7 +30,7 @@ A few things that make Rudder stand out:
   is self-contained, via a single package, and can auto-update to limit agent
   management burden.
 * Rudder is a *true and professional open source* solution—the team behind Rudder
-  doesn’t believe in the dual-speed licensing approach that makes you reinstall
+  doesn't believe in the dual-speed licensing approach that makes you reinstall
   everything and promotes open source as little more than a “demo version.”
 
 Rudder is an established project with *several 10000s of node managed*, in companies
@@ -41,17 +39,17 @@ The biggest known deployment in 2017 is about 7000 nodes.
 
 image::dashboard-overview.png["Rudder dashboard", align="center"]
 
-==== Made for production environments
+== Made for production environments
 
-We believe that there is a growing impedence mismatch between the Short Time of
-application development and deployement, and the Long Time of the infrastructure.
+We believe that there is a growing impedance mismatch between the Short Time of
+application development and deployment, and the Long Time of the infrastructure.
 The latter need rationalisation, stability and conformity before catching the hyped
 techno of the day, to be able to deliver reliable technical platform, continuously
 working with a minimum of risks.
 
 Rudder was made for the Long Time, to help team deliver efficient infrastructures with
 simplicity, giving them feedback where needed, keeping them alert of possible
-incoming problem, continously checking conformity to their rules, and all of that
+incoming problem, continuously checking conformity to their rules, and all of that
 whatever the infrastructure they choose to build.
 
 image::introduction/build_run_devops.png["Modern IT production of services and Open Source automation tools stack", align="center"]
@@ -64,7 +62,7 @@ At each level (global, by configuration policy, by node, etc), you can choose to
 either *Audit* the component - and no modification at all will made on it -, or to
 *Enforce* the policy, automatically correcting a drift if needed.
 
-==== Different roles for a better accessibility
+== Different roles for a better accessibility
 
 Rudder was thought from the start for plug&play-ability: easy to install and to
 upgrade, easy to start with and growth with.
@@ -79,7 +77,7 @@ conformity level to their policies or inventory (both software and hardware) of
 server at any time.
 
 
-==== Universality
+== Universality
 
 Rudder agent is extremely fast, light, and versatile. It works on a wide variety
 of OS or hardware, from physical server to cloud instance, user laptops or even