From c0966df4ab252dc378832a41e6c89ac717c35c2d Mon Sep 17 00:00:00 2001 From: Silvia Mitter Date: Sat, 3 Feb 2018 05:21:34 +0100 Subject: [PATCH] Making docs troubleshooting section more generic. (#6251) Use variables for the discuss forum and the github repository. --- auditbeat/docs/index.asciidoc | 2 ++ filebeat/docs/index.asciidoc | 2 ++ heartbeat/docs/index.asciidoc | 2 ++ libbeat/docs/getting-help.asciidoc | 6 +++--- libbeat/docs/index.asciidoc | 3 +++ metricbeat/docs/index.asciidoc | 2 ++ packetbeat/docs/index.asciidoc | 2 ++ winlogbeat/docs/index.asciidoc | 2 ++ 8 files changed, 18 insertions(+), 3 deletions(-) diff --git a/auditbeat/docs/index.asciidoc b/auditbeat/docs/index.asciidoc index 1b1910c3a9fc..567d6eafa6c5 100644 --- 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 index 3ea05402c648..60d1aae4bbde 100644 --- 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 index 3375bba2dee9..d150b0372e44 100644 --- 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 index 2deddac7655e..2404de19a022 100644 --- 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 <> 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. \ No newline at end of file +don't indicate the presence of a bug. diff --git a/libbeat/docs/index.asciidoc b/libbeat/docs/index.asciidoc index d5f2cd91ca15..e3e0cda0fd63 100644 --- 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 index fac0b821b112..448e3074d80f 100644 --- 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 index dec9f38215b5..c66e24d101c0 100644 --- 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 index b1666fe02ee7..8adf10ea621e 100644 --- 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[]