Merge pull request elastic#1919 from tsg/single_version_in_docs

Unify doc version handling
ruflin · Jun 28, 2016 · c8c7a29 · c8c7a29
2 parents ee38038 + 4b80571
commit c8c7a29
Show file tree

Hide file tree

Showing 11 changed files with 60 additions and 33 deletions.
diff --git a/filebeat/docs/index.asciidoc b/filebeat/docs/index.asciidoc
@@ -1,11 +1,14 @@
 = Filebeat Reference
-:libbeat: http://www.elastic.co/guide/en/beats/libbeat/master
-:packetbeat: http://www.elastic.co/guide/en/beats/packetbeat/master
-:metricbeat: http://www.elastic.co/guide/en/beats/metricbeat/master
-:filebeat: http://www.elastic.co/guide/en/beats/filebeat/master
-:winlogbeat: http://www.elastic.co/guide/en/beats/winlogbeat/master
-:elasticsearch: https://www.elastic.co/guide/en/elasticsearch/reference/master/
-:version: 5.0.0-alpha3
+
+include::./version.asciidoc[]
+
+:libbeat: http://www.elastic.co/guide/en/beats/libbeat/{doc-branch}
+:packetbeat: http://www.elastic.co/guide/en/beats/packetbeat/{doc-branch}
+:metricbeat: http://www.elastic.co/guide/en/beats/metricbeat/{doc-branch}
+:filebeat: http://www.elastic.co/guide/en/beats/filebeat/{doc-branch}
+:winlogbeat: http://www.elastic.co/guide/en/beats/winlogbeat/{doc-branch}
+:elasticsearch: https://www.elastic.co/guide/en/elasticsearch/reference/{doc-branch}/
+:version: {stack-version}
 :beatname_lc: filebeat
 :beatname_uc: Filebeat
 :security: X-Pack Security

diff --git a/filebeat/docs/version.asciidoc b/filebeat/docs/version.asciidoc
@@ -0,0 +1,2 @@
+:stack-version: 5.0.0-alpha3
+:doc-branch: master
diff --git a/libbeat/docs/index.asciidoc b/libbeat/docs/index.asciidoc
@@ -1,14 +1,16 @@
 [[beats-reference]]
 = Beats Platform Reference
-:packetbeat: http://www.elastic.co/guide/en/beats/packetbeat/master
-:metricbeat: http://www.elastic.co/guide/en/beats/metricbeat/master
-:filebeat: http://www.elastic.co/guide/en/beats/filebeat/master
-:winlogbeat: http://www.elastic.co/guide/en/beats/winlogbeat/master
+
+include::./version.asciidoc[]
+
+:packetbeat: http://www.elastic.co/guide/en/beats/packetbeat/{doc-branch}
+:metricbeat: http://www.elastic.co/guide/en/beats/metricbeat/{doc-branch}
+:filebeat: http://www.elastic.co/guide/en/beats/filebeat/{doc-branch}
+:winlogbeat: http://www.elastic.co/guide/en/beats/winlogbeat/{doc-branch}
 :security: X-Pack Security
-:ES-version: 5.0.0-alpha3
-:LS-version: 5.0.0-alpha3
-:Kibana-version: 5.0.0-alpha3
-:Dashboards-version: 5.0.0-alpha3
+:ES-version: {stack-version}
+:LS-version: {stack-version}
+:Kibana-version: {stack-version}
 
 include::./overview.asciidoc[]
 

diff --git a/libbeat/docs/version.asciidoc b/libbeat/docs/version.asciidoc
@@ -0,0 +1,2 @@
+:stack-version: 5.0.0-alpha3
+:doc-branch: master
diff --git a/libbeat/scripts/Makefile b/libbeat/scripts/Makefile
@@ -230,6 +230,9 @@ update: python-env
 	. ${PYTHON_ENV}/bin/activate && python ${ES_BEATS}/libbeat/scripts/generate_template.py $(PWD) ${BEATNAME} ${ES_BEATS}
 	. ${PYTHON_ENV}/bin/activate && python ${ES_BEATS}/libbeat/scripts/generate_template.py --es2x $(PWD) ${BEATNAME} ${ES_BEATS}
 
+	# Update docs version
+	cp ${ES_BEATS}/libbeat/docs/version.asciidoc docs/version.asciidoc
+
 # Builds the documents for the beat
 .PHONY: docs
 docs:

diff --git a/metricbeat/docs/index.asciidoc b/metricbeat/docs/index.asciidoc
@@ -1,8 +1,11 @@
 = Metricbeat Reference
-:libbeat: http://www.elastic.co/guide/en/beats/libbeat/master
-:filebeat: http://www.elastic.co/guide/en/beats/filebeat/master
-:elasticsearch: https://www.elastic.co/guide/en/elasticsearch/reference/master/
-:version: 5.0.0-alpha3
+
+include::./version.asciidoc[]
+
+:libbeat: http://www.elastic.co/guide/en/beats/libbeat/{doc-branch}
+:filebeat: http://www.elastic.co/guide/en/beats/filebeat/{doc-branch}
+:elasticsearch: https://www.elastic.co/guide/en/elasticsearch/reference/{doc-branch}/
+:version: {stack-version}
 :beatname_lc: metricbeat
 :beatname_uc: Metricbeat
 :security: X-Pack Security

diff --git a/metricbeat/docs/version.asciidoc b/metricbeat/docs/version.asciidoc
@@ -0,0 +1,2 @@
+:stack-version: 5.0.0-alpha3
+:doc-branch: master
diff --git a/packetbeat/docs/index.asciidoc b/packetbeat/docs/index.asciidoc
@@ -1,11 +1,14 @@
 = Packetbeat Reference
-:libbeat: http://www.elastic.co/guide/en/beats/libbeat/master
-:packetbeat: http://www.elastic.co/guide/en/beats/packetbeat/master
-:metricbeat: http://www.elastic.co/guide/en/beats/metricbeat/master
-:filebeat: http://www.elastic.co/guide/en/beats/filebeat/master
-:winlogbeat: http://www.elastic.co/guide/en/beats/winlogbeat/master
-:elasticsearch: https://www.elastic.co/guide/en/elasticsearch/reference/master/
-:version: 5.0.0-alpha3
+
+include::./version.asciidoc[]
+
+:libbeat: http://www.elastic.co/guide/en/beats/libbeat/{doc-branch}
+:packetbeat: http://www.elastic.co/guide/en/beats/packetbeat/{doc-branch}
+:metricbeat: http://www.elastic.co/guide/en/beats/metricbeat/{doc-branch}
+:filebeat: http://www.elastic.co/guide/en/beats/filebeat/{doc-branch}
+:winlogbeat: http://www.elastic.co/guide/en/beats/winlogbeat/{doc-branch}
+:elasticsearch: https://www.elastic.co/guide/en/elasticsearch/reference/{doc-branch}/
+:version: {stack-version}
 :beatname_lc: packetbeat
 :beatname_uc: Packetbeat
 :security: X-Pack Security

diff --git a/packetbeat/docs/version.asciidoc b/packetbeat/docs/version.asciidoc
@@ -0,0 +1,2 @@
+:stack-version: 5.0.0-alpha3
+:doc-branch: master
diff --git a/winlogbeat/docs/index.asciidoc b/winlogbeat/docs/index.asciidoc
@@ -1,11 +1,14 @@
 = Winlogbeat Reference
-:libbeat: http://www.elastic.co/guide/en/beats/libbeat/master
-:packetbeat: http://www.elastic.co/guide/en/beats/packetbeat/master
-:metricbeat: http://www.elastic.co/guide/en/beats/metricbeat/master
-:filebeat: http://www.elastic.co/guide/en/beats/filebeat/master
-:winlogbeat: http://www.elastic.co/guide/en/beats/winlogbeat/master
-:elasticsearch: https://www.elastic.co/guide/en/elasticsearch/reference/master/
-:version: 5.0.0-alpha3
+
+include::./version.asciidoc[]
+
+:libbeat: http://www.elastic.co/guide/en/beats/libbeat/{doc-branch}
+:packetbeat: http://www.elastic.co/guide/en/beats/packetbeat/{doc-branch}
+:metricbeat: http://www.elastic.co/guide/en/beats/metricbeat/{doc-branch}
+:filebeat: http://www.elastic.co/guide/en/beats/filebeat/{doc-branch}
+:winlogbeat: http://www.elastic.co/guide/en/beats/winlogbeat/{doc-branch}
+:elasticsearch: https://www.elastic.co/guide/en/elasticsearch/reference/{doc-branch}/
+:version: {stack-version}
 :beatname_lc: winlogbeat
 :beatname_uc: Winlogbeat
 :security: X-Pack Security

diff --git a/winlogbeat/docs/version.asciidoc b/winlogbeat/docs/version.asciidoc
@@ -0,0 +1,2 @@
+:stack-version: 5.0.0-alpha3
+:doc-branch: master