[7.5] [docs] Directory structure for copied docs (elastic#3094)(elast…

…ic#3115) (elastic#3117)
bmorelli25 · Jan 9, 2020 · 58fd692 · 58fd692
1 parent e7e7256
commit 58fd692
Show file tree

Hide file tree

Showing 44 changed files with 49 additions and 101 deletions.
diff --git a/NOTICE.txt b/NOTICE.txt
@@ -1,5 +1,5 @@
 Apm Server
-Copyright 2014-2019 Elasticsearch BV
+Copyright 2014-2020 Elasticsearch BV
 
 This product includes software developed by The Apache Software 
 Foundation (http://www.apache.org/).

diff --git a/...ied-from-beats/command-reference.asciidoc → ...rom-beats/docs/command-reference.asciidoc b/...ied-from-beats/command-reference.asciidoc → ...rom-beats/docs/command-reference.asciidoc
diff --git a/docs/copied-from-beats/debugging.asciidoc → ...copied-from-beats/docs/debugging.asciidoc b/docs/copied-from-beats/debugging.asciidoc → ...copied-from-beats/docs/debugging.asciidoc
diff --git a/docs/copied-from-beats/getting-help.asciidoc → ...ied-from-beats/docs/getting-help.asciidoc b/docs/copied-from-beats/getting-help.asciidoc → ...ied-from-beats/docs/getting-help.asciidoc
diff --git a/docs/copied-from-beats/https.asciidoc → docs/copied-from-beats/docs/https.asciidoc b/docs/copied-from-beats/https.asciidoc → docs/copied-from-beats/docs/https.asciidoc
diff --git a/docs/copied-from-beats/keystore.asciidoc → .../copied-from-beats/docs/keystore.asciidoc b/docs/copied-from-beats/keystore.asciidoc → .../copied-from-beats/docs/keystore.asciidoc
diff --git a/.../copied-from-beats/loggingconfig.asciidoc → ...ed-from-beats/docs/loggingconfig.asciidoc b/.../copied-from-beats/loggingconfig.asciidoc → ...ed-from-beats/docs/loggingconfig.asciidoc
diff --git a/...eats/monitoring/monitoring-beats.asciidoc → ...docs/monitoring/monitoring-beats.asciidoc b/...eats/monitoring/monitoring-beats.asciidoc → ...docs/monitoring/monitoring-beats.asciidoc
diff --git a/...g/monitoring-internal-collection.asciidoc → ...g/monitoring-internal-collection.asciidoc b/...g/monitoring-internal-collection.asciidoc → ...g/monitoring-internal-collection.asciidoc
diff --git a/...monitoring/monitoring-metricbeat.asciidoc → ...monitoring/monitoring-metricbeat.asciidoc b/...monitoring/monitoring-metricbeat.asciidoc → ...monitoring/monitoring-metricbeat.asciidoc
diff --git a/...monitoring/shared-monitor-config.asciidoc → ...monitoring/shared-monitor-config.asciidoc b/...monitoring/shared-monitor-config.asciidoc → ...monitoring/shared-monitor-config.asciidoc
diff --git a/...-from-beats/outputs/output-cloud.asciidoc → ...ied-from-beats/docs/output-cloud.asciidoc b/...-from-beats/outputs/output-cloud.asciidoc → ...ied-from-beats/docs/output-cloud.asciidoc
diff --git a/docs/copied-from-beats/outputconfig.asciidoc → ...ied-from-beats/docs/outputconfig.asciidoc b/docs/copied-from-beats/outputconfig.asciidoc → ...ied-from-beats/docs/outputconfig.asciidoc
@@ -25,32 +25,10 @@ security-related configuration options.
 
 // end::shared-outputconfig[]
 
-* <<elasticsearch-output>>
-* <<logstash-output>>
-* <<kafka-output>>
-ifndef::no-output-redis[]
-* <<redis-output>>
-endif::[]
-* <<file-output>>
-* <<console-output>>
-* <<configure-cloud-id>>
+include::outputs-list.asciidoc[tag=outputs-list]
 
 ifdef::beat-specific-output-config[]
 include::{beat-specific-output-config}[]
 endif::[]
 
-include::outputs/output-elasticsearch.asciidoc[]
-
-include::outputs/output-logstash.asciidoc[]
-
-include::outputs/output-kafka.asciidoc[]
-
-include::outputs/output-redis.asciidoc[]
-
-include::outputs/output-file.asciidoc[]
-
-include::outputs/output-console.asciidoc[]
-
-include::outputs/output-cloud.asciidoc[]
-
-include::outputs/change-output-codec.asciidoc[]
+include::outputs-list.asciidoc[tag=outputs-include]
diff --git a/docs/copied-from-beats/docs/outputs-list.asciidoc b/docs/copied-from-beats/docs/outputs-list.asciidoc
@@ -0,0 +1,35 @@
+// TODO: Create script that generates this file. Conditional coding needs to
+// be preserved.
+
+//# tag::outputs-list[]
+
+* <<elasticsearch-output>>
+* <<logstash-output>>
+* <<kafka-output>>
+ifndef::no-output-redis[]
+* <<redis-output>>
+endif::[]
+* <<file-output>>
+* <<console-output>>
+* <<configure-cloud-id>>
+
+//# end::outputs-list[]
+
+//# tag::outputs-include[]
+include::{libbeat-outputs-dir}/elasticsearch/docs/elasticsearch.asciidoc[]
+
+include::{libbeat-outputs-dir}/logstash/docs/logstash.asciidoc[]
+
+include::{libbeat-outputs-dir}/kafka/docs/kafka.asciidoc[]
+
+include::{libbeat-outputs-dir}/redis/docs/redis.asciidoc[]
+
+include::{libbeat-outputs-dir}/fileout/docs/fileout.asciidoc[]
+
+include::{libbeat-outputs-dir}/console/docs/console.asciidoc[]
+
+include::output-cloud.asciidoc[]
+
+include::{libbeat-outputs-dir}/codec/docs/codec.asciidoc[]
+
+//# end::outputs-include[]
diff --git a/docs/copied-from-beats/repositories.asciidoc → ...ied-from-beats/docs/repositories.asciidoc b/docs/copied-from-beats/repositories.asciidoc → ...ied-from-beats/docs/repositories.asciidoc
diff --git a/...d-from-beats/security/basic-auth.asciidoc → ...m-beats/docs/security/basic-auth.asciidoc b/...d-from-beats/security/basic-auth.asciidoc → ...m-beats/docs/security/basic-auth.asciidoc
diff --git a/...from-beats/security/beats-system.asciidoc → ...beats/docs/security/beats-system.asciidoc b/...from-beats/security/beats-system.asciidoc → ...beats/docs/security/beats-system.asciidoc
diff --git a/...rom-beats/security/linux-seccomp.asciidoc → ...eats/docs/security/linux-seccomp.asciidoc b/...rom-beats/security/linux-seccomp.asciidoc → ...eats/docs/security/linux-seccomp.asciidoc
diff --git a/...om-beats/security/securing-beats.asciidoc → ...ats/docs/security/securing-beats.asciidoc b/...om-beats/security/securing-beats.asciidoc → ...ats/docs/security/securing-beats.asciidoc
diff --git a/docs/copied-from-beats/security/tls.asciidoc → ...ied-from-beats/docs/security/tls.asciidoc b/docs/copied-from-beats/security/tls.asciidoc → ...ied-from-beats/docs/security/tls.asciidoc
diff --git a/...copied-from-beats/security/users.asciidoc → ...d-from-beats/docs/security/users.asciidoc b/...copied-from-beats/security/users.asciidoc → ...d-from-beats/docs/security/users.asciidoc
diff --git a/...ed-from-beats/shared-configuring.asciidoc → ...om-beats/docs/shared-configuring.asciidoc b/...ed-from-beats/shared-configuring.asciidoc → ...om-beats/docs/shared-configuring.asciidoc
diff --git a/...om-beats/shared-directory-layout.asciidoc → ...ats/docs/shared-directory-layout.asciidoc b/...om-beats/shared-directory-layout.asciidoc → ...ats/docs/shared-directory-layout.asciidoc
diff --git a/.../copied-from-beats/shared-docker.asciidoc → ...ed-from-beats/docs/shared-docker.asciidoc b/.../copied-from-beats/shared-docker.asciidoc → ...ed-from-beats/docs/shared-docker.asciidoc
diff --git a/...opied-from-beats/shared-env-vars.asciidoc → ...-from-beats/docs/shared-env-vars.asciidoc b/...opied-from-beats/shared-env-vars.asciidoc → ...-from-beats/docs/shared-env-vars.asciidoc
diff --git a/...ed-from-beats/shared-path-config.asciidoc → ...om-beats/docs/shared-path-config.asciidoc b/...ed-from-beats/shared-path-config.asciidoc → ...om-beats/docs/shared-path-config.asciidoc
diff --git a/...-from-beats/shared-securing-beat.asciidoc → ...-beats/docs/shared-securing-beat.asciidoc b/...-from-beats/shared-securing-beat.asciidoc → ...-beats/docs/shared-securing-beat.asciidoc
@@ -27,7 +27,7 @@ endif::[]
 --
 
 ifdef::apm-server[]
-include::../secure-communication-agents.asciidoc[]
+include::{docdir}/secure-communication-agents.asciidoc[]
 endif::[]
 
 //sets block macro for https.asciidoc included in next section

diff --git a/...ied-from-beats/shared-ssl-config.asciidoc → ...rom-beats/docs/shared-ssl-config.asciidoc b/...ied-from-beats/shared-ssl-config.asciidoc → ...rom-beats/docs/shared-ssl-config.asciidoc
diff --git a/...beats/shared-ssl-logstash-config.asciidoc → .../docs/shared-ssl-logstash-config.asciidoc b/...beats/shared-ssl-logstash-config.asciidoc → .../docs/shared-ssl-logstash-config.asciidoc
diff --git a/...copied-from-beats/shared-systemd.asciidoc → ...d-from-beats/docs/shared-systemd.asciidoc b/...copied-from-beats/shared-systemd.asciidoc → ...d-from-beats/docs/shared-systemd.asciidoc
@@ -37,6 +37,7 @@ sudo systemctl enable {beatname_lc}
 sudo systemctl disable {beatname_lc}
 ------------------------------------------------
 
+
 ==== {beatname_uc} status and logs
 
 To get the service status, use `systemctl`:
@@ -107,5 +108,5 @@ include drop-in unit files. If you need to add a drop-in manually, use
 +systemctl edit {beatname_lc}.service+.
 
 ifdef::apm-server[]
-include::./../config-ownership.asciidoc[]
-endif::apm-server[]
+include::{docdir}/config-ownership.asciidoc[]
+endif::apm-server[]
diff --git a/...-from-beats/shared-template-load.asciidoc → ...-beats/docs/shared-template-load.asciidoc b/...-from-beats/shared-template-load.asciidoc → ...-beats/docs/shared-template-load.asciidoc
diff --git a/...pied-from-beats/step-test-config.asciidoc → ...from-beats/docs/step-test-config.asciidoc b/...pied-from-beats/step-test-config.asciidoc → ...from-beats/docs/step-test-config.asciidoc
diff --git a/...opied-from-beats/template-config.asciidoc → ...-from-beats/docs/template-config.asciidoc b/...opied-from-beats/template-config.asciidoc → ...-from-beats/docs/template-config.asciidoc
diff --git a/...eats/outputs/change-output-codec.asciidoc → ...m-beats/outputs/codec/docs/codec.asciidoc b/...eats/outputs/change-output-codec.asciidoc → ...m-beats/outputs/codec/docs/codec.asciidoc
diff --git a/...rom-beats/outputs/output-console.asciidoc → ...ats/outputs/console/docs/console.asciidoc b/...rom-beats/outputs/output-console.asciidoc → ...ats/outputs/console/docs/console.asciidoc
diff --git a/...ats/outputs/output-elasticsearch.asciidoc → ...elasticsearch/docs/elasticsearch.asciidoc b/...ats/outputs/output-elasticsearch.asciidoc → ...elasticsearch/docs/elasticsearch.asciidoc
diff --git a/...d-from-beats/outputs/output-file.asciidoc → ...ats/outputs/fileout/docs/fileout.asciidoc b/...d-from-beats/outputs/output-file.asciidoc → ...ats/outputs/fileout/docs/fileout.asciidoc
diff --git a/...-from-beats/outputs/output-kafka.asciidoc → ...m-beats/outputs/kafka/docs/kafka.asciidoc b/...-from-beats/outputs/output-kafka.asciidoc → ...m-beats/outputs/kafka/docs/kafka.asciidoc
diff --git a/...om-beats/outputs/output-logstash.asciidoc → ...s/outputs/logstash/docs/logstash.asciidoc b/...om-beats/outputs/output-logstash.asciidoc → ...s/outputs/logstash/docs/logstash.asciidoc
diff --git a/...-from-beats/outputs/output-redis.asciidoc → ...m-beats/outputs/redis/docs/redis.asciidoc b/...-from-beats/outputs/output-redis.asciidoc → ...m-beats/outputs/redis/docs/redis.asciidoc
diff --git a/docs/copied-from-beats/shared-logstash-config.asciidoc b/docs/copied-from-beats/shared-logstash-config.asciidoc
diff --git a/docs/index.asciidoc b/docs/index.asciidoc
@@ -1,7 +1,8 @@
 include::./version.asciidoc[]
 include::{asciidoc-dir}/../../shared/attributes.asciidoc[]
 
-:libbeat-dir: {docdir}/copied-from-beats
+:libbeat-dir: {docdir}/copied-from-beats/docs
+:libbeat-outputs-dir: {docdir}/copied-from-beats/outputs
 :version: {apm_server_version}
 :beatname_lc: apm-server
 :beatname_uc: APM Server
@@ -52,10 +53,10 @@ include::./setting-up-and-running.asciidoc[]
 
 include::./upgrading.asciidoc[]
 
-:beat-specific-output-config: ./../configuring-output-after.asciidoc
+:beat-specific-output-config: {docdir}/configuring-output-after.asciidoc
 include::./configuring.asciidoc[]
 
-:beat-specific-security: ../security.asciidoc
+:beat-specific-security: {docdir}/security.asciidoc
 include::{libbeat-dir}/shared-securing-beat.asciidoc[]
 
 include::{libbeat-dir}/monitoring/monitoring-beats.asciidoc[]

diff --git a/docs/troubleshooting.asciidoc b/docs/troubleshooting.asciidoc
@@ -29,9 +29,9 @@ include::common-problems.asciidoc[]
 [[enable-apm-server-debugging]]
 == Debug
 
-include::copied-from-beats/debugging.asciidoc[]
+include::{libbeat-dir}/debugging.asciidoc[]
 
 [[getting-help]]
 == Get help
 
-include::copied-from-beats/getting-help.asciidoc[]
+include::{libbeat-dir}/getting-help.asciidoc[]
diff --git a/script/copy-docs.py b/script/copy-docs.py
@@ -15,7 +15,7 @@ def is_dir(d):
 def main():
     parser = argparse.ArgumentParser()
     parser.add_argument('-t', '--target_dir', type=is_dir, default='docs/copied-from-beats')
-    parser.add_argument('-s', '--source_dir', type=is_dir, default='../beats/libbeat/docs')
+    parser.add_argument('-s', '--source_dir', type=is_dir, default='../beats/libbeat')
     args = parser.parse_args()
 
     start = len(args.target_dir.strip("/"))+1