Making docs troubleshooting section more generic. (#6251)

Use variables for the discuss forum and the github repository.
elastic · Feb 3, 2018 · c0966df · c0966df
1 parent 70b2c99
commit c0966df
Show file tree

Hide file tree

Showing 8 changed files with 18 additions and 3 deletions.
diff --git a/auditbeat/docs/index.asciidoc b/auditbeat/docs/index.asciidoc
@@ -8,6 +8,8 @@ include::{asciidoc-dir}/../../shared/attributes.asciidoc[]
 :beatname_lc: auditbeat
 :beatname_uc: Auditbeat
 :beatname_pkg: {beatname_lc}
+:github_repo_name: beats
+:discuss_forum: beats/{beatname_lc}
 
 include::../../libbeat/docs/shared-beats-attributes.asciidoc[]
 

diff --git a/filebeat/docs/index.asciidoc b/filebeat/docs/index.asciidoc
@@ -8,6 +8,8 @@ include::{asciidoc-dir}/../../shared/attributes.asciidoc[]
 :beatname_lc: filebeat
 :beatname_uc: Filebeat
 :beatname_pkg: {beatname_lc}
+:github_repo_name: beats
+:discuss_forum: beats/{beatname_lc}
 
 include::../../libbeat/docs/shared-beats-attributes.asciidoc[]
 

diff --git a/heartbeat/docs/index.asciidoc b/heartbeat/docs/index.asciidoc
@@ -8,6 +8,8 @@ include::{asciidoc-dir}/../../shared/attributes.asciidoc[]
 :beatname_lc: heartbeat
 :beatname_uc: Heartbeat
 :beatname_pkg: heartbeat-elastic
+:github_repo_name: beats
+:discuss_forum: beats/{beatname_lc}
 
 include::../../libbeat/docs/shared-beats-attributes.asciidoc[]
 

diff --git a/libbeat/docs/getting-help.asciidoc b/libbeat/docs/getting-help.asciidoc
@@ -9,7 +9,7 @@
 //// include::../../libbeat/docs/getting-help.asciidoc[]
 //////////////////////////////////////////////////////////////////////////
 
-Start by searching the https://discuss.elastic.co/c/beats/{beatname_lc}[{beatname_uc} discussion forum] for your issue. If you can't find a resolution, open a new issue or add a comment to an existing one. Make sure you provide the following information, and we'll help
+Start by searching the https://discuss.elastic.co/c/{discuss_forum}[{beatname_uc} discussion forum] for your issue. If you can't find a resolution, open a new issue or add a comment to an existing one. Make sure you provide the following information, and we'll help
 you troubleshoot the problem:
 
 * {beatname_uc} version
@@ -19,6 +19,6 @@ you troubleshoot the problem:
 problem. See <<enable-{beatname_lc}-debugging>> for more details.
 
 If you're sure you found a bug, you can open a ticket on
-https://github.com/elastic/beats/issues?state=open[GitHub]. Note, however,
+https://github.com/elastic/{github_repo_name}/issues?state=open[GitHub]. Note, however,
 that we close GitHub issues containing questions or requests for help if they
-don't indicate the presence of a bug.
+don't indicate the presence of a bug.
diff --git a/libbeat/docs/index.asciidoc b/libbeat/docs/index.asciidoc
@@ -8,6 +8,9 @@ include::{asciidoc-dir}/../../shared/attributes.asciidoc[]
 :beatname_lc: beatname
 :beatname_uc: a Beat
 :beatname_pkg: {beatname_lc}
+:github_repo_name: beats
+:discuss_forum: beats/{beatname_lc}
+
 
 include::../../libbeat/docs/shared-beats-attributes.asciidoc[]
 

diff --git a/metricbeat/docs/index.asciidoc b/metricbeat/docs/index.asciidoc
@@ -8,6 +8,8 @@ include::{asciidoc-dir}/../../shared/attributes.asciidoc[]
 :beatname_lc: metricbeat
 :beatname_uc: Metricbeat
 :beatname_pkg: {beatname_lc}
+:github_repo_name: beats
+:discuss_forum: beats/{beatname_lc}
 
 include::../../libbeat/docs/shared-beats-attributes.asciidoc[]
 

diff --git a/packetbeat/docs/index.asciidoc b/packetbeat/docs/index.asciidoc
@@ -8,6 +8,8 @@ include::{asciidoc-dir}/../../shared/attributes.asciidoc[]
 :beatname_lc: packetbeat
 :beatname_uc: Packetbeat
 :beatname_pkg: {beatname_lc}
+:github_repo_name: beats
+:discuss_forum: beats/{beatname_lc}
 
 include::../../libbeat/docs/shared-beats-attributes.asciidoc[]
 

diff --git a/winlogbeat/docs/index.asciidoc b/winlogbeat/docs/index.asciidoc
@@ -8,6 +8,8 @@ include::{asciidoc-dir}/../../shared/attributes.asciidoc[]
 :beatname_lc: winlogbeat
 :beatname_uc: Winlogbeat
 :beatname_pkg: {beatname_lc}
+:github_repo_name: beats
+:discuss_forum: beats/{beatname_lc}
 
 include::../../libbeat/docs/shared-beats-attributes.asciidoc[]