Skip to content

Commit

Permalink
[Docs] Asciidoctor support (#10730)
Browse files Browse the repository at this point in the history
Ports elastic/logstash-docs#688 to this repo. Asciidoctor doesn't quite
work on this repo, but it comes closer with these changes.
  • Loading branch information
nik9000 committed May 1, 2019
1 parent 5d64a61 commit 0793bf1
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 2 deletions.
4 changes: 3 additions & 1 deletion docs/include/input.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -152,7 +152,8 @@ a new input will not override the existing type. A type set at
the shipper stays with that event for its life even
when sent to another Logstash server.

ifeval::["{type}"=="input" and "{plugin}"=="beats"]
ifeval::["{type}"=="input"]
ifeval::["{plugin}"=="beats"]

ifeval::["{versioned_docs}"!="true"]
NOTE: The Beats shipper automatically sets the `type` field on the event.
Expand All @@ -168,4 +169,5 @@ Logstash, it is ignored.
endif::[]

endif::[]
endif::[]

6 changes: 5 additions & 1 deletion docs/include/plugin_header.asciidoc
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
ifeval::["{versioned_docs}"!="true"]
[subs="attributes"]
++++
<titleabbrev>{plugin}</titleabbrev>
++++
endif::[]
ifeval::["{versioned_docs}"=="true"]
[subs="attributes"]
++++
<titleabbrev>{version}</titleabbrev>
++++
Expand All @@ -28,12 +30,14 @@ To learn more about Logstash, see the {logstash-ref}/index.html[Logstash Referen

endif::[]

ifeval::[("{default_plugin}"=="0") and ("{versioned_docs}"!="true")]
ifeval::["{default_plugin}"=="0"]
ifeval::["{versioned_docs}"!="true"]

==== Installation

For plugins not bundled by default, it is easy to install by running +bin/logstash-plugin install logstash-{type}-{plugin}+. See {logstash-ref}/working-with-plugins.html[Working with plugins] for more details.

endif::[]
endif::[]

==== Getting Help
Expand Down
1 change: 1 addition & 0 deletions docs/include/version-list-intro.asciidoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
[id="{type}-{plugin}-index"]

== Versioned {plugin} {type} plugin docs
[subs="attributes"]
++++
<titleabbrev>{plugin}</titleabbrev>
++++
Expand Down

0 comments on commit 0793bf1

Please sign in to comment.