Add abbreviated titles for a cleaner nav (elastic#16537)

dedemorton · Mar 3, 2020 · 5b2ea9d · 5b2ea9d
1 parent e142cea
commit 5b2ea9d
Show file tree

Hide file tree

Showing 33 changed files with 128 additions and 8 deletions.
diff --git a/libbeat/processors/actions/docs/add_fields.asciidoc b/libbeat/processors/actions/docs/add_fields.asciidoc
@@ -1,6 +1,10 @@
 [[add-fields]]
 === Add fields
 
+++++
+<titleabbrev>add_fields</titleabbrev>
+++++
+
 The `add_fields` processor adds additional fields to the event.  Fields can be
 scalar values, arrays, dictionaries, or any nested combination of these.  By
 default the fields that you specify will be grouped under the `fields`

diff --git a/libbeat/processors/actions/docs/add_labels.asciidoc b/libbeat/processors/actions/docs/add_labels.asciidoc
@@ -1,6 +1,10 @@
 [[add-labels]]
 === Add labels
 
+++++
+<titleabbrev>add_labels</titleabbrev>
+++++
+
 The `add_labels` processors adds a set of key-value pairs to an event.
 The processor will flatten nested configuration objects like arrays or
 dictionaries into a fully qualified name by merging nested names with a `.`.

diff --git a/libbeat/processors/actions/docs/add_tags.asciidoc b/libbeat/processors/actions/docs/add_tags.asciidoc
@@ -1,6 +1,10 @@
 [[add-tags]]
 === Add tags
 
+++++
+<titleabbrev>add_tags</titleabbrev>
+++++
+
 The `add_tags` processor adds tags to a list of tags. If the target field already exists,
 the tags are appended to the existing list of tags.
 

diff --git a/libbeat/processors/actions/docs/copy_fields.asciidoc b/libbeat/processors/actions/docs/copy_fields.asciidoc
@@ -1,6 +1,10 @@
 [[copy-fields]]
 === Copy fields
 
+++++
+<titleabbrev>copy_fields</titleabbrev>
+++++
+
 The `copy_fields` processor copies a field to another one.
 
 `fields`:: List of `from` and `to` pairs to copy from and to.

diff --git a/libbeat/processors/actions/docs/decode_base64_field.asciidoc b/libbeat/processors/actions/docs/decode_base64_field.asciidoc
@@ -1,6 +1,10 @@
 [[decode-base64-field]]
 === Decode Base64 fields
 
+++++
+<titleabbrev>decode_base64_field</titleabbrev>
+++++
+
 The `decode_base64_field` processor specifies a field to base64 decode.
 The `field` key contains a `from: old-key` and a `to: new-key` pair. `from` is
 the origin and `to` the target name of the field.

diff --git a/libbeat/processors/actions/docs/decode_json_fields.asciidoc b/libbeat/processors/actions/docs/decode_json_fields.asciidoc
@@ -1,6 +1,10 @@
 [[decode-json-fields]]
 === Decode JSON fields
 
+++++
+<titleabbrev>decode_json_fields</titleabbrev>
+++++
+
 The `decode_json_fields` processor decodes fields containing JSON strings and
 replaces the strings with valid JSON objects.
 

diff --git a/libbeat/processors/actions/docs/decompress_gzip_field.asciidoc b/libbeat/processors/actions/docs/decompress_gzip_field.asciidoc
@@ -1,6 +1,10 @@
 [[decompress-gzip-field]]
 === Decompress gzip fields
 
+++++
+<titleabbrev>decompress_gzip_field</titleabbrev>
+++++
+
 The `decompress_gzip_field` processor specifies a field to gzip decompress.
 The `field` key contains a `from: old-key` and a `to: new-key` pair. `from` is
 the origin and `to` the target name of the field.

diff --git a/libbeat/processors/actions/docs/drop_event.asciidoc b/libbeat/processors/actions/docs/drop_event.asciidoc
@@ -1,6 +1,10 @@
 [[drop-event]]
 === Drop events
 
+++++
+<titleabbrev>drop_event</titleabbrev>
+++++
+
 The `drop_event` processor drops the entire event if the associated condition
 is fulfilled. The condition is mandatory, because without one, all the events
 are dropped.

diff --git a/libbeat/processors/actions/docs/drop_fields.asciidoc b/libbeat/processors/actions/docs/drop_fields.asciidoc
@@ -1,6 +1,10 @@
 [[drop-fields]]
 === Drop fields from events
 
+++++
+<titleabbrev>drop_fields</titleabbrev>
+++++
+
 The `drop_fields` processor specifies which fields to drop if a certain
 condition is fulfilled. The condition is optional. If it's missing, the
 specified fields are always dropped. The `@timestamp` and `type` fields cannot

diff --git a/libbeat/processors/actions/docs/include_fields.asciidoc b/libbeat/processors/actions/docs/include_fields.asciidoc
@@ -1,6 +1,10 @@
 [[include-fields]]
 === Keep fields from events
 
+++++
+<titleabbrev>include_fields</titleabbrev>
+++++
+
 The `include_fields` processor specifies which fields to export if a certain
 condition is fulfilled. The condition is optional. If it's missing, the
 specified fields are always exported. The `@timestamp` and `type` fields are

diff --git a/libbeat/processors/actions/docs/placeholder.asciidoc b/libbeat/processors/actions/docs/placeholder.asciidoc
diff --git a/libbeat/processors/actions/docs/rename.asciidoc b/libbeat/processors/actions/docs/rename.asciidoc
@@ -1,6 +1,10 @@
 [[rename-fields]]
 === Rename fields from events
 
+++++
+<titleabbrev>rename</titleabbrev>
+++++
+
 The `rename` processor specifies a list of fields to rename. Under the `fields`
 key, each entry contains a `from: old-key` and a `to: new-key` pair, where:
 

diff --git a/libbeat/processors/actions/docs/truncate_fields.asciidoc b/libbeat/processors/actions/docs/truncate_fields.asciidoc
@@ -1,6 +1,10 @@
 [[truncate-fields]]
 === Truncate fields
 
+++++
+<titleabbrev>truncate_fields</titleabbrev>
+++++
+
 The `truncate_fields` processor truncates a field to a given size. If the size of the field is smaller than
 the limit, the field is left as is.
 

diff --git a/libbeat/processors/add_cloud_metadata/docs/add_cloud_metadata.asciidoc b/libbeat/processors/add_cloud_metadata/docs/add_cloud_metadata.asciidoc
@@ -1,6 +1,10 @@
 [[add-cloud-metadata]]
 === Add cloud metadata
 
+++++
+<titleabbrev>add_cloud_metadata</titleabbrev>
+++++
+
 The `add_cloud_metadata` processor enriches each event with instance metadata
 from the machine's hosting provider. At startup it will query a list of hosting
 providers and cache the instance metadata.

diff --git a/libbeat/processors/add_docker_metadata/docs/add_docker_metadata.asciidoc b/libbeat/processors/add_docker_metadata/docs/add_docker_metadata.asciidoc
@@ -1,6 +1,10 @@
 [[add-docker-metadata]]
 === Add Docker metadata
 
+++++
+<titleabbrev>add_docker_metadata</titleabbrev>
+++++
+
 The `add_docker_metadata` processor annotates each event with relevant metadata
 from Docker containers. At startup it detects a docker environment and caches the metadata.
 The events are annotated with Docker metadata, only if a valid configuration

diff --git a/libbeat/processors/add_host_metadata/docs/add_host_metadata.asciidoc b/libbeat/processors/add_host_metadata/docs/add_host_metadata.asciidoc
@@ -1,6 +1,10 @@
 [[add-host-metadata]]
 === Add Host metadata
 
+++++
+<titleabbrev>add_host_metadata</titleabbrev>
+++++
+
 [source,yaml]
 -------------------------------------------------------------------------------
 processors:

diff --git a/libbeat/processors/add_id/docs/add_id.asciidoc b/libbeat/processors/add_id/docs/add_id.asciidoc
@@ -1,6 +1,10 @@
 [[add-id]]
 === Generate an ID for an event
 
+++++
+<titleabbrev>add_id</titleabbrev>
+++++
+
 The `add_id` processor generates a unique ID for an event.
 
 [source,yaml]

diff --git a/libbeat/processors/add_kubernetes_metadata/docs/add_kubernetes_metadata.asciidoc b/libbeat/processors/add_kubernetes_metadata/docs/add_kubernetes_metadata.asciidoc
@@ -1,6 +1,10 @@
 [[add-kubernetes-metadata]]
 === Add Kubernetes metadata
 
+++++
+<titleabbrev>add_kubernetes_metadata</titleabbrev>
+++++
+
 The `add_kubernetes_metadata` processor annotates each event with relevant
 metadata based on which Kubernetes pod the event originated from.
 At startup it detects an `in_cluster` environment and caches the

diff --git a/libbeat/processors/add_locale/docs/add_locale.asciidoc b/libbeat/processors/add_locale/docs/add_locale.asciidoc
@@ -1,6 +1,10 @@
 [[add-locale]]
 === Add the local time zone
 
+++++
+<titleabbrev>add_locale</titleabbrev>
+++++
+
 The `add_locale` processor enriches each event with the machine's time zone
 offset from UTC or with the name of the time zone. It supports one configuration
 option named `format` that controls whether an offset or time zone abbreviation

diff --git a/libbeat/processors/add_observer_metadata/docs/add_observer_metadata.asciidoc b/libbeat/processors/add_observer_metadata/docs/add_observer_metadata.asciidoc
@@ -1,6 +1,10 @@
 [[add-observer-metadata]]
 === Add Observer metadata
 
+++++
+<titleabbrev>add_observer_metadata</titleabbrev>
+++++
+
 beta[]
 
 [source,yaml]

diff --git a/libbeat/processors/add_process_metadata/docs/add_process_metadata.asciidoc b/libbeat/processors/add_process_metadata/docs/add_process_metadata.asciidoc
@@ -1,7 +1,11 @@
 [[add-process-metadata]]
 === Add process metadata
 
-The Add process metadata processor enriches events with information from running
+++++
+<titleabbrev>add_process_metadata</titleabbrev>
+++++
+
+The `add_process_metadata` processor enriches events with information from running
 processes, identified by their process ID (PID).
 
 [source,yaml]

diff --git a/libbeat/processors/communityid/docs/communityid.asciidoc b/libbeat/processors/communityid/docs/communityid.asciidoc
@@ -1,6 +1,10 @@
 [[community-id]]
 === Community ID Network Flow Hash
 
+++++
+<titleabbrev>community_id</titleabbrev>
+++++
+
 The `community_id` processor computes a network flow hash according to the
 https://github.com/corelight/community-id-spec[Community ID Flow Hash
 specification].

diff --git a/libbeat/processors/convert/docs/convert.asciidoc b/libbeat/processors/convert/docs/convert.asciidoc
@@ -1,6 +1,10 @@
 [[convert]]
 === Convert
 
+++++
+<titleabbrev>convert</titleabbrev>
+++++
+
 The `convert` processor converts a field in the event to a different type, such
 as converting a string to an integer.
 

diff --git a/libbeat/processors/decode_csv_fields/docs/decode_csv_fields.asciidoc b/libbeat/processors/decode_csv_fields/docs/decode_csv_fields.asciidoc
@@ -1,6 +1,10 @@
 [[decode-csv-fields]]
 === Decode CSV fields
 
+++++
+<titleabbrev>decode_csv_fields</titleabbrev>
+++++
+
 experimental[]
 
 The `decode_csv_fields` processor decodes fields containing records in

diff --git a/libbeat/processors/dissect/docs/dissect.asciidoc b/libbeat/processors/dissect/docs/dissect.asciidoc
@@ -1,7 +1,11 @@
 [[dissect]]
 === Dissect strings
 
-The dissect processor tokenizes incoming strings using defined patterns.
+++++
+<titleabbrev>dissect</titleabbrev>
+++++
+
+The `dissect` processor tokenizes incoming strings using defined patterns.
 
 [source,yaml]
 -------

diff --git a/libbeat/processors/dns/docs/dns.asciidoc b/libbeat/processors/dns/docs/dns.asciidoc
@@ -1,7 +1,11 @@
 [[processor-dns]]
 === DNS Reverse Lookup
 
-The DNS processor performs reverse DNS lookups of IP addresses. It caches the
+++++
+<titleabbrev>dns</titleabbrev>
+++++
+
+The `dns` processor performs reverse DNS lookups of IP addresses. It caches the
 responses that it receives in accordance to the time-to-live (TTL) value
 contained in the response. It also caches failures that occur during lookups.
 Each instance of this processor maintains its own independent cache.

diff --git a/libbeat/processors/extract_array/docs/extract_array.asciidoc b/libbeat/processors/extract_array/docs/extract_array.asciidoc
@@ -1,6 +1,10 @@
 [[extract-array]]
 === Extract array
 
+++++
+<titleabbrev>extract_array</titleabbrev>
+++++
+
 experimental[]
 
 The `extract_array` processor populates fields with values read from an array

diff --git a/libbeat/processors/fingerprint/docs/fingerprint.asciidoc b/libbeat/processors/fingerprint/docs/fingerprint.asciidoc
@@ -1,6 +1,10 @@
 [[fingerprint]]
 === Generate a fingerprint of an event
 
+++++
+<titleabbrev>fingerprint</titleabbrev>
+++++
+
 The `fingerprint` processor generates a fingerprint of an event based on a
 specified subset of its fields.
 

diff --git a/libbeat/processors/registered_domain/docs/registered_domain.asciidoc b/libbeat/processors/registered_domain/docs/registered_domain.asciidoc
@@ -1,6 +1,10 @@
 [[processor-registered-domain]]
 === Registered Domain
 
+++++
+<titleabbrev>registered_domain</titleabbrev>
+++++
+
 The `registered_domain` processor reads a field containing a hostname and then
 writes the "registered domain" contained in the hostname to the target field.
 For example, given `www.google.co.uk` the processor would output `google.co.uk`.

diff --git a/libbeat/processors/script/docs/script.asciidoc b/libbeat/processors/script/docs/script.asciidoc
@@ -1,7 +1,11 @@
 [[processor-script]]
 === Script Processor
 
-The script processor executes Javascript code to process an event. The processor
+++++
+<titleabbrev>script</titleabbrev>
+++++
+
+The `script` processor executes Javascript code to process an event. The processor
 uses a pure Go implementation of ECMAScript 5.1 and has no external
 dependencies. This can be useful in situations where one of the other processors
 doesn't provide the functionality you need to filter events.

diff --git a/libbeat/processors/timestamp/docs/timestamp.asciidoc b/libbeat/processors/timestamp/docs/timestamp.asciidoc
@@ -1,6 +1,10 @@
 [[processor-timestamp]]
 === Timestamp
 
+++++
+<titleabbrev>timestamp</titleabbrev>
+++++
+
 beta[]
 
 The `timestamp` processor parses a timestamp from a field. By default the

diff --git a/x-pack/filebeat/processors/decode_cef/docs/decode_cef.asciidoc b/x-pack/filebeat/processors/decode_cef/docs/decode_cef.asciidoc
@@ -2,6 +2,10 @@
 [role="xpack"]
 === Decode CEF
 
+++++
+<titleabbrev>decode_cef</titleabbrev>
+++++
+
 beta[]
 
 The `decode_cef` processor decodes Common Event Format (CEF) messages. This

diff --git a/x-pack/filebeat/processors/decode_cef/docs/placeholder.asciidoc b/x-pack/filebeat/processors/decode_cef/docs/placeholder.asciidoc