broken ascii doc on plugin repos

jsvd · jsvd · commit ec4557444028 · 2018-01-24T11:52:06.000Z
diff --git a/docs/versioned-plugins/codecs/compress_spooler-v2.0.6.asciidoc b/docs/versioned-plugins/codecs/compress_spooler-v2.0.6.asciidoc
@@ -20,7 +20,7 @@ include::{include_path}/plugin_header.asciidoc[]
 
 ==== Description
 
-The compress_spooler codec.
+
 
 [id="{version}-plugins-{type}s-{plugin}-options"]
 ==== Compress_spooler Codec Configuration Options
diff --git a/docs/versioned-plugins/codecs/csv-v0.1.4.asciidoc b/docs/versioned-plugins/codecs/csv-v0.1.4.asciidoc
@@ -20,7 +20,7 @@ include::{include_path}/plugin_header.asciidoc[]
 
 ==== Description
 
-The csv codec.
+
 
 [id="{version}-plugins-{type}s-{plugin}-options"]
 ==== Csv Codec Configuration Options
diff --git a/docs/versioned-plugins/codecs/multiline-v3.0.9.asciidoc b/docs/versioned-plugins/codecs/multiline-v3.0.9.asciidoc
@@ -24,7 +24,7 @@ The multiline codec will collapse multiline messages and merge them into a
 single event.
 
 IMPORTANT: If you are using a Logstash input plugin that supports multiple
-hosts, such as the {logstash-ref}/plugins-inputs-beats.html[beats input plugin] input plugin, you should not use
+hosts, such as the <<plugins-inputs-beats>> input plugin, you should not use
 the multiline codec to handle multiline events. Doing so may result in the
 mixing of streams and corrupted event data. In this situation, you need to
 handle multiline events before sending the event data to Logstash. 
diff --git a/docs/versioned-plugins/codecs/s3plain-v2.0.7.asciidoc b/docs/versioned-plugins/codecs/s3plain-v2.0.7.asciidoc
@@ -1,4 +1,4 @@
-:plugin: s3plain
+:plugin: s3_plain
 :type: codec
 
 ///////////////////////////////////////////
@@ -14,11 +14,19 @@ END - GENERATED VARIABLES, DO NOT EDIT!
 
 [id="{version}-plugins-{type}s-{plugin}"]
 
-=== S3plain
+=== S3_plain
 
 include::{include_path}/plugin_header.asciidoc[]
 
 ==== Description
 
 The "s3_plain" codec is used for backward compatibility with previous version of the S3 Output
 
+
+[id="{version}-plugins-{type}s-{plugin}-options"]
+==== S3_plain Codec Configuration Options
+
+[cols="<,<,<",options="header",]
+|=======================================================================
+|Setting |Input type|Required
+|=======================================================================
diff --git a/docs/versioned-plugins/filters/anonymize-v3.0.6.asciidoc b/docs/versioned-plugins/filters/anonymize-v3.0.6.asciidoc
@@ -20,7 +20,7 @@ include::{include_path}/plugin_header.asciidoc[]
 
 ==== Description
 
-deprecated[3.0.3,We recommend that you use the {logstash-ref}/plugins-filters-fingerprint.html[fingerprint filter plugin] instead.]
+deprecated[3.0.3,We recommend that you use the <<plugins-filters-fingerprint,fingerprint filter plugin>> instead.]
 
 Anonymize fields by replacing values with a consistent hash.
 
diff --git a/docs/versioned-plugins/filters/fingerprint-v3.1.2.asciidoc b/docs/versioned-plugins/filters/fingerprint-v3.1.2.asciidoc
@@ -33,7 +33,7 @@ you must set the key, otherwise the plugin will raise an exception
 NOTE: When the `target` option is set to `UUID` the result won't be
 a consistent hash but a random
 https://en.wikipedia.org/wiki/Universally_unique_identifier[UUID].
-To generate UUIDs, prefer the {logstash-ref}/plugins-filters-uuid.html[uuid filter].
+To generate UUIDs, prefer the <<plugins-filters-uuid,uuid filter>>.
 
 [id="{version}-plugins-{type}s-{plugin}-options"]
 ==== Fingerprint Filter Configuration Options
diff --git a/docs/versioned-plugins/filters/geoip-v5.0.3.asciidoc b/docs/versioned-plugins/filters/geoip-v5.0.3.asciidoc
@@ -43,7 +43,7 @@ A `[geoip][location]` field is created if
 the GeoIP lookup returns a latitude and longitude. The field is stored in
 http://geojson.org/geojson-spec.html[GeoJSON] format. Additionally,
 the default Elasticsearch template provided with the
-{logstash-ref}/plugins-outputs-elasticsearch.html[`elasticsearch` output] maps
+<<plugins-outputs-elasticsearch,`elasticsearch` output>> maps
 the `[geoip][location]` field to an http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/mapping-geo-point-type.html#_mapping_options[Elasticsearch geo_point].
 
 As this field is a `geo_point` _and_ it is still valid GeoJSON, you get
diff --git a/docs/versioned-plugins/filters/multiline-v3.0.4.asciidoc b/docs/versioned-plugins/filters/multiline-v3.0.4.asciidoc
@@ -39,7 +39,7 @@ The config looks like this:
       }
     }
 
-The `pattern` should be a regexp ({logstash-ref}/plugins-filters-grok.html[grok] patterns are
+The `pattern` should be a regexp (<<plugins-filters-grok,grok>> patterns are
 supported) which matches what you believe to be an indicator that the field
 is part of an event consisting of multiple lines of log data.
 
@@ -131,7 +131,7 @@ Negate the regexp pattern ('if not matched')
   * There is no default value for this setting.
 
 The expression to match. The same matching engine as the
-{logstash-ref}/plugins-filters-grok.html[grok filter] is used, so the expression can contain
+<<plugins-filters-grok,grok filter>> is used, so the expression can contain
 a plain regular expression or one that also contains grok patterns.
 
 [id="{version}-plugins-{type}s-{plugin}-patterns_dir"]
diff --git a/docs/versioned-plugins/filters/prune-v3.0.3.asciidoc b/docs/versioned-plugins/filters/prune-v3.0.3.asciidoc
@@ -24,8 +24,8 @@ The prune filter is for removing fields from events based on
 whitelists or blacklist of field names or their values (names and
 values can also be regular expressions).
 
-This can e.g. be useful if you have a {logstash-ref}/plugins-filters-json.html[json]
-or {logstash-ref}/plugins-filters-kv.html[kv] filter that creates a number of fields
+This can e.g. be useful if you have a <<plugins-filters-json,json>>
+or <<plugins-filters-kv,kv>> filter that creates a number of fields
 with names that you don't necessarily know the names of beforehand,
 and you only want to keep a subset of them.
 
diff --git a/docs/versioned-plugins/filters/split-v3.1.6.asciidoc b/docs/versioned-plugins/filters/split-v3.1.6.asciidoc
@@ -25,7 +25,7 @@ placing each value resulting from the split into a clone of the original
 event. The field being split can either be a string or an array.
 
 An example use case of this filter is for taking output from the
-{logstash-ref}/plugins-inputs-exec.html[exec input plugin] which emits one event for
+<<plugins-inputs-exec,exec input plugin>> which emits one event for
 the whole output of a command and splitting that output by newline -
 making each line an event.
 
diff --git a/docs/versioned-plugins/filters/unique-v3.0.0.asciidoc b/docs/versioned-plugins/filters/unique-v3.0.0.asciidoc
@@ -20,7 +20,7 @@ include::{include_path}/plugin_header.asciidoc[]
 
 ==== Description
 
-The unique filter.
+
 
 [id="{version}-plugins-{type}s-{plugin}-options"]
 ==== Unique Filter Configuration Options
diff --git a/docs/versioned-plugins/filters/uuid-v3.0.5.asciidoc b/docs/versioned-plugins/filters/uuid-v3.0.5.asciidoc
@@ -28,7 +28,7 @@ This is useful if you need to generate a string that's unique for every
 event, even if the same input is processed multiple times. If you want
 to generate strings that are identical each time a event with a given
 content is processed (i.e. a hash) you should use the
-{logstash-ref}/plugins-filters-fingerprint.html[fingerprint filter] instead.
+<<plugins-filters-fingerprint,fingerprint filter>> instead.
 
 The generated UUIDs follow the version 4 definition in
 https://tools.ietf.org/html/rfc4122[RFC 4122]) and will be
diff --git a/docs/versioned-plugins/filters/yaml-v0.1.1.asciidoc b/docs/versioned-plugins/filters/yaml-v0.1.1.asciidoc
@@ -12,7 +12,7 @@ START - GENERATED VARIABLES, DO NOT EDIT!
 END - GENERATED VARIABLES, DO NOT EDIT!
 ///////////////////////////////////////////
 
-[id="{version}-plugins-{type}s-{plugin}"]
+[id="{version}-plugins-{type}-{plugin}"]
 
 === Yaml filter plugin {version}
 
diff --git a/docs/versioned-plugins/inputs/beats-v5.0.6.asciidoc b/docs/versioned-plugins/inputs/beats-v5.0.6.asciidoc
@@ -52,7 +52,7 @@ Logstash, it is ignored.
 IMPORTANT: If you are shipping events that span multiple lines, you need to
 use the https://www.elastic.co/guide/en/beats/filebeat/current/multiline-examples.html[configuration options available in Filebeat] to handle multiline events
 before sending the event data to Logstash. You cannot use the
-{logstash-ref}/plugins-codecs-multiline.html[Multiline codec plugin] codec to handle multiline events. Doing so will
+<<plugins-codecs-multiline>> codec to handle multiline events. Doing so will
 result in the failure to start Logstash.
 
 
diff --git a/docs/versioned-plugins/inputs/file-v4.0.3.asciidoc b/docs/versioned-plugins/inputs/file-v4.0.3.asciidoc
@@ -201,7 +201,7 @@ of `/var/log` will be done for all `*.log` files.
 Paths must be absolute and cannot be relative.
 
 You may also configure multiple paths. See an example
-on the {logstash-ref}/configuration-file-structure.html#array[Logstash configuration page].
+on the <<array,Logstash configuration page>>.
 
 [id="{version}-plugins-{type}s-{plugin}-sincedb_path"]
 ===== `sincedb_path` 
diff --git a/docs/versioned-plugins/inputs/journald-v2.0.1.asciidoc b/docs/versioned-plugins/inputs/journald-v2.0.1.asciidoc
@@ -12,7 +12,7 @@ START - GENERATED VARIABLES, DO NOT EDIT!
 END - GENERATED VARIABLES, DO NOT EDIT!
 ///////////////////////////////////////////
 
-[id="{version}-plugins-{type}s-{plugin}"]
+[id="{version}-plugins-{type}-{plugin}"]
 
 === Journald input plugin {version}
 
diff --git a/docs/versioned-plugins/inputs/lumberjack-v3.1.4.asciidoc b/docs/versioned-plugins/inputs/lumberjack-v3.1.4.asciidoc
@@ -24,7 +24,7 @@ Receive events using the Lumberjack protocol.
 
 This input can be used to reliably and securely transport
 events between Logstash instances. To do so, use the
-{logstash-ref}/plugins-outputs-lumberjack.html[lumberjack output plugin]
+<<plugins-outputs-lumberjack,lumberjack output plugin>>
 in the sending Logstash instance(s).
 
 It can also be used to receive events from the deprecated
diff --git a/docs/versioned-plugins/inputs/rackspace-v3.0.1.asciidoc b/docs/versioned-plugins/inputs/rackspace-v3.0.1.asciidoc
@@ -12,15 +12,15 @@ START - GENERATED VARIABLES, DO NOT EDIT!
 END - GENERATED VARIABLES, DO NOT EDIT!
 ///////////////////////////////////////////
 
-[id="{version}-plugins-{type}s-{plugin}"]
+[id="{version}-plugins-{type}-{plugin}"]
 
 === Rackspace input plugin {version}
 
 include::{include_path}/plugin_header.asciidoc[]
 
 ==== Description
 
-The rackspace input.
+
 
 [id="{version}-plugins-{type}s-{plugin}-options"]
 ==== Rackspace Input Configuration Options
diff --git a/docs/versioned-plugins/inputs/zeromq-v3.0.3.asciidoc b/docs/versioned-plugins/inputs/zeromq-v3.0.3.asciidoc
@@ -12,7 +12,7 @@ START - GENERATED VARIABLES, DO NOT EDIT!
 END - GENERATED VARIABLES, DO NOT EDIT!
 ///////////////////////////////////////////
 
-[id="{version}-plugins-{type}s-{plugin}"]
+[id="{version}-plugins-{type}-{plugin}"]
 
 === Zeromq input plugin {version}
 
diff --git a/docs/versioned-plugins/outputs/elasticsearch_java-v2.1.4.asciidoc b/docs/versioned-plugins/outputs/elasticsearch_java-v2.1.4.asciidoc
@@ -12,7 +12,7 @@ START - GENERATED VARIABLES, DO NOT EDIT!
 END - GENERATED VARIABLES, DO NOT EDIT!
 ///////////////////////////////////////////
 
-[id="{version}-plugins-{type}s-{plugin}"]
+[id="{version}-plugins-{type}-{plugin}"]
 
 === Elasticsearch_java output plugin {version}
 
diff --git a/docs/versioned-plugins/outputs/hipchat-v4.0.3.asciidoc b/docs/versioned-plugins/outputs/hipchat-v4.0.3.asciidoc
@@ -12,7 +12,7 @@ START - GENERATED VARIABLES, DO NOT EDIT!
 END - GENERATED VARIABLES, DO NOT EDIT!
 ///////////////////////////////////////////
 
-[id="{version}-plugins-{type}s-{plugin}"]
+[id="{version}-plugins-{type}-{plugin}"]
 
 === Hipchat output plugin {version}
 
diff --git a/docs/versioned-plugins/outputs/jms-v3.0.1.asciidoc b/docs/versioned-plugins/outputs/jms-v3.0.1.asciidoc
@@ -12,7 +12,7 @@ START - GENERATED VARIABLES, DO NOT EDIT!
 END - GENERATED VARIABLES, DO NOT EDIT!
 ///////////////////////////////////////////
 
-[id="{version}-plugins-{type}s-{plugin}"]
+[id="{version}-plugins-{type}-{plugin}"]
 
 === Jms output plugin {version}
 
diff --git a/docs/versioned-plugins/outputs/neo4j-v2.0.5.asciidoc b/docs/versioned-plugins/outputs/neo4j-v2.0.5.asciidoc
@@ -12,15 +12,15 @@ START - GENERATED VARIABLES, DO NOT EDIT!
 END - GENERATED VARIABLES, DO NOT EDIT!
 ///////////////////////////////////////////
 
-[id="{version}-plugins-{type}s-{plugin}"]
+[id="{version}-plugins-{type}-{plugin}"]
 
 === Neo4j output plugin {version}
 
 include::{include_path}/plugin_header.asciidoc[]
 
 ==== Description
 
-The neo4j output.
+
 
 [id="{version}-plugins-{type}s-{plugin}-options"]
 ==== Neo4j Output Configuration Options
diff --git a/docs/versioned-plugins/outputs/null-v3.0.4.asciidoc b/docs/versioned-plugins/outputs/null-v3.0.4.asciidoc
@@ -26,9 +26,12 @@ performance.
 [id="{version}-plugins-{type}s-{plugin}-options"]
 ==== Null Output Configuration Options
 
-There are no special configuration options for this plugin,
-but it does support the <<{version}-plugins-{type}s-{plugin}-common-options>>.
+This plugin supports the following configuration options plus the <<{version}-plugins-{type}s-{plugin}-common-options>> described later.
 
+[cols="<,<,<",options="header",]
+|=======================================================================
+|Setting |Input type|Required
+|=======================================================================
 
 [id="{version}-plugins-{type}s-{plugin}-common-options"]
 include::{include_path}/{type}.asciidoc[]
diff --git a/docs/versioned-plugins/outputs/slack-v2.1.0.asciidoc b/docs/versioned-plugins/outputs/slack-v2.1.0.asciidoc
@@ -20,7 +20,7 @@ include::{include_path}/plugin_header.asciidoc[]
 
 ==== Description
 
-The slack output.
+
 
 [id="{version}-plugins-{type}s-{plugin}-options"]
 ==== Slack Output Configuration Options
diff --git a/docs/versioned-plugins/outputs/sns-v4.0.6.asciidoc b/docs/versioned-plugins/outputs/sns-v4.0.6.asciidoc
@@ -43,8 +43,8 @@ This plugin looks for the following fields on events it receives:
 ==== Upgrading to 2.0.0
 
 This plugin used to have a `format` option for controlling the encoding of messages prior to being sent to SNS.
-This plugin now uses the logstash standard {logstash-ref}/configuration-file-structure.html#codec[codec] option for encoding instead.
-If you want the same 'plain' format as the v0/1 codec (`format => "plain"`) use `codec => "s3plain"`.
+This plugin now uses the logstash standard <<codec,codec>> option for encoding instead.
+If you want the same 'plain' format as the v0/1 codec (`format => "plain"`) use `codec => "s3_plain"`.
 
 
 [id="{version}-plugins-{type}s-{plugin}-options"]

Original file line number	Diff line number	Diff line change
`@@ -39,7 +39,7 @@ The config looks like this:`
`39`	`39`	`}`
`40`	`40`	`}`
`41`	`41`
`42`		-The `pattern` should be a regexp ({logstash-ref}/plugins-filters-grok.html[grok] patterns are
	`42`	+The `pattern` should be a regexp (<<plugins-filters-grok,grok>> patterns are
`43`	`43`	`supported) which matches what you believe to be an indicator that the field`
`44`	`44`	`is part of an event consisting of multiple lines of log data.`
`45`	`45`
`@@ -131,7 +131,7 @@ Negate the regexp pattern ('if not matched')`
`131`	`131`	`* There is no default value for this setting.`
`132`	`132`
`133`	`133`	`The expression to match. The same matching engine as the`
`134`		`-{logstash-ref}/plugins-filters-grok.html[grok filter] is used, so the expression can contain`
	`134`	`+<<plugins-filters-grok,grok filter>> is used, so the expression can contain`
`135`	`135`	`a plain regular expression or one that also contains grok patterns.`
`136`	`136`
`137`	`137`	`[id="{version}-plugins-{type}s-{plugin}-patterns_dir"]`