Fixes #14099: Add documentation about rudder <-> plugin version compa…

…tibility in docs
Normation · Jan 7, 2019 · cdff0a1 · cdff0a1
1 parent 452f3be
commit cdff0a1
Show file tree

Hide file tree

Showing 4 changed files with 18 additions and 5 deletions.
diff --git a/src/reference/Makefile b/src/reference/Makefile
@@ -3,7 +3,7 @@
 .PHONY: clean $(ADOC_DYN_FILES) nav
 
 ADOC_SRC_FILES = $(shell find modules/ROOT/pages -type f -name '*.adoc')
-ADOC_DYN_FILES = generic_methods.adoc hooks.adoc rudder.adoc versions.adoc
+ADOC_DYN_FILES = generic_methods.adoc hooks.adoc rudder.adoc versions.adoc version-compat.adoc
 GRAPHVIZ_FILES = $(shell find modules/reference/assets/graphviz -type f -name '*.dot')
 GRAPHVIZ_IMAGES = $(addprefix modules/reference/assets/images/graphviz/, $(notdir $(GRAPHVIZ_FILES:dot=png)))
 
@@ -33,11 +33,16 @@ hooks.adoc:
 	mkdir -p modules/usage/pages/_partials/dyn/
 	cp dependencies/$@ modules/usage/pages/_partials/dyn/$@
 
+version-compat.adoc:
+	cd dependencies && make $@
+	mkdir -p modules/plugins/pages/_partials/dyn/
+	cp dependencies/$@ modules/plugins/pages/_partials/dyn/$@
+
 plugins:
 	cd dependencies && make $@
 	cp -r dependencies/$@/* modules/plugins/
 	echo "index.adoc" > modules/plugins/nav.list
-	find modules/plugins/pages ! -name 'index.adoc' -type f | sed 's/.*\///' >> modules/plugins/nav.list
+	find modules/plugins/pages ! -name 'index.adoc' ! -name 'version-compat.adoc' -type f | sed 's/.*\///' >> modules/plugins/nav.list
 
 nav: $(ADOC_SRC_FILES) plugins
 	./tools/generate-nav.py ROOT "Introduction" > modules/ROOT/nav.adoc

diff --git a/src/reference/dependencies/.gitignore b/src/reference/dependencies/.gitignore
@@ -4,6 +4,7 @@ generic_methods.adoc
 generic_methods.md
 hooks.adoc
 rudder.adoc
+version-compat.adoc
 rudder.8
 /rudder-agent-repo/
 /ncf-repo/

diff --git a/src/reference/dependencies/Makefile b/src/reference/dependencies/Makefile
@@ -2,8 +2,8 @@
 
 RUDDER_VERSION = 5.0
 
-.PHONY: clean generic_methods.adoc rudder.adoc hooks.adoc plugins versions.adoc
-all: generic_methods.adoc hooks.adoc rudder.adoc plugins
+.PHONY: clean generic_methods.adoc rudder.adoc hooks.adoc plugins versions.adoc version-compat.adoc
+all: generic_methods.adoc hooks.adoc rudder.adoc plugins version-compat.adoc
 
 ## Repos
 
@@ -60,6 +60,11 @@ generic_methods.adoc: ncf-repo rudder-agent-windows-repo
 	sed -i 's/```.*/```/' generic_methods.md
 	pandoc -t asciidoc -f markdown generic_methods.md > generic_methods.adoc
 
+version-compat.adoc: rudder-plugins-repo 
+	cd rudder-plugins-repo && git checkout branches/rudder/$(RUDDER_VERSION) 2>/dev/null || git checkout master
+	cd rudder-plugins-repo && git pull
+	cp rudder-plugins-repo/version-compat.adoc version-compat.adoc
+
 plugins: rudder-plugins-repo rudder-plugins-private-repo
 	cd rudder-plugins-private-repo && git checkout branches/rudder/$(RUDDER_VERSION) 2>/dev/null || git checkout master
 	cd rudder-plugins-private-repo && git pull && make clean && make doc
@@ -72,7 +77,7 @@ plugins: rudder-plugins-repo rudder-plugins-private-repo
 ## Clean
 
 clean:
-	rm -rf generic_methods.{adoc,md} hooks.adoc rudder.adoc plugins
+	rm -rf generic_methods.{adoc,md} hooks.adoc rudder.adoc version-compat.adoc plugins
 
 veryclean: clean
 	rm -rf rudder-agent-repo rudder-repo ncf-repo rudder-agent-windows-repo rudder-plugins-repo rudder-plugins-private-repo
diff --git a/src/reference/modules/plugins/pages/index.adoc b/src/reference/modules/plugins/pages/index.adoc
@@ -44,3 +44,5 @@ See all available commands with:
 ----
 /opt/rudder/bin/rudder-pkg --help
 ----
+
+include::{partialsdir}/dyn/version-compat.adoc[leveloffset=+1]