Skip to content

Commit

Permalink
[docs] Clean up output docs to use opt-out includes (elastic#16539) (e…
Browse files Browse the repository at this point in the history
  • Loading branch information
dedemorton authored Feb 29, 2020
1 parent fd40854 commit d55db9f
Show file tree
Hide file tree
Showing 6 changed files with 63 additions and 28 deletions.
3 changes: 0 additions & 3 deletions libbeat/docs/outputconfig.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@
//// Make sure this content appears below a level 2 heading.
//////////////////////////////////////////////////////////////////////////

// tag::shared-outputconfig[]

[[configuring-output]]
== Configure the output
Expand All @@ -23,8 +22,6 @@ The following topics describe how to configure each supported output. If you've
secured the {stack}, also read <<securing-{beatname_lc}>> for more about
security-related configuration options.

// end::shared-outputconfig[]

include::outputs-list.asciidoc[tag=outputs-list]

ifdef::beat-specific-output-config[]
Expand Down
54 changes: 53 additions & 1 deletion libbeat/docs/outputs-list.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,33 +3,85 @@

//# tag::outputs-list[]

ifndef::no_es_output[]
* <<elasticsearch-output>>
endif::[]
ifndef::no_ls_output[]
* <<logstash-output>>
endif::[]
ifndef::no_kafka_output[]
* <<kafka-output>>
ifndef::no-output-redis[]
endif::[]
ifndef::no_redis_output[]
* <<redis-output>>
endif::[]
ifndef::no_file_output[]
* <<file-output>>
endif::[]
ifndef::no_console_output[]
* <<console-output>>
endif::[]
ifndef::no_cloud_id[]
* <<configure-cloud-id>>
endif::[]

//# end::outputs-list[]

//# tag::outputs-include[]
ifndef::no_es_output[]
ifdef::requires_xpack[]
[role="xpack"]
endif::[]
include::{libbeat-outputs-dir}/elasticsearch/docs/elasticsearch.asciidoc[]
endif::[]

ifndef::no_ls_output[]
ifdef::requires_xpack[]
[role="xpack"]
endif::[]
include::{libbeat-outputs-dir}/logstash/docs/logstash.asciidoc[]
endif::[]

ifndef::no_kafka_output[]
ifdef::requires_xpack[]
[role="xpack"]
endif::[]
include::{libbeat-outputs-dir}/kafka/docs/kafka.asciidoc[]
endif::[]

ifndef::no_redis_output[]
ifdef::requires_xpack[]
[role="xpack"]
endif::[]
include::{libbeat-outputs-dir}/redis/docs/redis.asciidoc[]
endif::[]

ifndef::no_file_output[]
ifdef::requires_xpack[]
[role="xpack"]
endif::[]
include::{libbeat-outputs-dir}/fileout/docs/fileout.asciidoc[]
endif::[]

ifndef::no_console_output[]
ifdef::requires_xpack[]
[role="xpack"]
endif::[]
include::{libbeat-outputs-dir}/console/docs/console.asciidoc[]
endif::[]

ifndef::no_cloud_id[]
ifdef::requires_xpack[]
[role="xpack"]
endif::[]
include::output-cloud.asciidoc[]
endif::[]

ifndef::no_codec[]
ifdef::requires_xpack[]
[role="xpack"]
endif::[]
include::{libbeat-outputs-dir}/codec/docs/codec.asciidoc[]
endif::[]

//# end::outputs-include[]
8 changes: 4 additions & 4 deletions libbeat/docs/reference-yml.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -10,16 +10,16 @@ TIP: The reference file is located in the same directory as the

The contents of the file are included here for your convenience.

ifndef::has_xpack[]
ifndef::requires_xpack[]
[source,yaml]
----
include::../../{beatname_lc}/{beatname_lc}.reference.yml[]
----
endif::has_xpack[]
endif::requires_xpack[]

ifdef::has_xpack[]
ifdef::requires_xpack[]
[source,yaml]
----
include::../../x-pack/{beatname_lc}/{beatname_lc}.reference.yml[]
----
endif::has_xpack[]
endif::requires_xpack[]
5 changes: 0 additions & 5 deletions libbeat/outputs/redis/docs/redis.asciidoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
//begin inner exclude for redis
ifndef::no-output-redis[]
[[redis-output]]
=== Configure the Redis output

Expand Down Expand Up @@ -252,6 +250,3 @@ client. You can change this behavior by setting the

This option determines whether Redis hostnames are resolved locally when using a proxy.
The default value is false, which means that name resolution occurs on the proxy server.

//end inner exclude for redis
endif::[]
15 changes: 1 addition & 14 deletions x-pack/functionbeat/docs/configuring-howto.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -44,20 +44,7 @@ include::{libbeat-dir}/queueconfig.asciidoc[]
:allplatforms!:

[role="xpack"]
include::{libbeat-dir}/outputconfig.asciidoc[tag=shared-outputconfig]

* <<elasticsearch-output>>
* <<logstash-output>>
* <<configure-cloud-id>>

[role="xpack"]
include::{libbeat-outputs-dir}/elasticsearch/docs/elasticsearch.asciidoc[]

[role="xpack"]
include::{libbeat-outputs-dir}/logstash/docs/logstash.asciidoc[]

[role="xpack"]
include::{libbeat-dir}/output-cloud.asciidoc[]
include::{libbeat-dir}/outputconfig.asciidoc[]

[role="xpack"]
include::{libbeat-dir}/shared-ilm.asciidoc[]
Expand Down
6 changes: 5 additions & 1 deletion x-pack/functionbeat/docs/index.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,12 @@ include::{asciidoc-dir}/../../shared/attributes.asciidoc[]
:has_ml_jobs: no
:libbeat-docs: Beats Platform Reference
:cloudformation-ref: https://aws.amazon.com/cloudformation/[AWS CloudFormation]
:no_kafka_output:
:no_redis_output:
:no_file_output:
:has_xpack:
:no_console_output:
:no_codec:
:requires_xpack:
:serverless:
:mac_os:
:win_os:
Expand Down

0 comments on commit d55db9f

Please sign in to comment.