Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fixes #14099: Add documentation about rudder <-> plugin version compatibility in docs #553

Merged
merged 1 commit into from
Jan 7, 2019
Merged

Fixes #14099: Add documentation about rudder <-> plugin version compatibility in docs #553

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 7 additions & 2 deletions src/reference/Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)))

Expand Down Expand Up @@ -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
Expand Down
1 change: 1 addition & 0 deletions src/reference/dependencies/.gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ generic_methods.adoc
generic_methods.md
hooks.adoc
rudder.adoc
version-compat.adoc
rudder.8
/rudder-agent-repo/
/ncf-repo/
Expand Down
11 changes: 8 additions & 3 deletions src/reference/dependencies/Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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
Expand All @@ -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
2 changes: 2 additions & 0 deletions src/reference/modules/plugins/pages/index.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,3 +44,5 @@ See all available commands with:
----
/opt/rudder/bin/rudder-pkg --help
----

include::{partialsdir}/dyn/version-compat.adoc[leveloffset=+1]