Merge pull request #1946 from fluent/lynettemiles/sc-136245/update-fluent-bit-docs-pipeline-outputs-kafka

Author: esmerel

pipeline/outputs/kafka-rest-proxy.md

@@ -1,40 +1,42 @@
-# Kafka REST Proxy
+# Kafka REST proxy
 
-The **kafka-rest** output plugin, allows to flush your records into a [Kafka REST Proxy](http://docs.confluent.io/current/kafka-rest/docs/index.html) server. The following instructions assumes that you have a fully operational Kafka REST Proxy and Kafka services running in your environment.
+The _Kafka rest_ (`kafka-rest`) output plugin lets you flush your records into a [Kafka REST Proxy](http://docs.confluent.io/current/kafka-rest/docs/index.html) server. The following instructions assume you have an operational Kafka REST Proxy and Kafka services running in your environment.
 
-## Configuration Parameters
+## Configuration parameters
+
+This plugin supports the following parameters:
 
 | Key | Description | default |
 | :--- | :--- | :--- |
-| Host | IP address or hostname of the target Kafka REST Proxy server | 127.0.0.1 |
-| Port | TCP port of the target Kafka REST Proxy server | 8082 |
-| Topic | Set the Kafka topic | fluent-bit |
-| Partition | Set the partition number \(optional\) |  |
-| Message\_Key | Set a message key \(optional\) |  |
-| Time\_Key | The Time\_Key property defines the name of the field that holds the record timestamp. | @timestamp |
-| Time\_Key\_Format | Defines the format of the timestamp. | %Y-%m-%dT%H:%M:%S |
-| Include\_Tag\_Key | Append the Tag name to the final record. | Off |
-| Tag\_Key | If Include\_Tag\_Key is enabled, this property defines the key name for the tag. | \_flb-key |
-| Workers | The number of [workers](../../administration/multithreading.md#outputs) to perform flush operations for this output. | `0` |
+| `Host` | IP address or hostname of the target Kafka REST Proxy server. | `127.0.0.1` |
+| `Port` | TCP port of the target Kafka REST Proxy server. | `8082` |
+| `Topic` | Set the Kafka topic. | `fluent-bit` |
+| `Partition` | Optional. Set the partition number. | _none_ |
+| `Message_Key` | Optional. Set a message key. | _none_ |
+| `Time_Key` | The `Time_Key` property defines the name of the field that holds the record timestamp. | `@timestamp` |
+| `Time_Key_Format` | Defines the format of the timestamp. | `%Y-%m-%dT%H:%M:%S` |
+| `Include_Tag_Key` | Append the Tag name to the final record. | `Off` |
+| `Tag_Key` | If `Include_Tag_Key` is enabled, this property defines the key name for the tag. | `_flb-key` |
+| `Workers` | The number of [workers](../../administration/multithreading.md#outputs) to perform flush operations for this output. | `0` |
 
 ### TLS / SSL
 
 The Kafka REST Proxy output plugin supports TLS/SSL.
 For more details about the properties available and general configuration, see [TLS/SSL](../../administration/transport-security.md).
 
-## Getting Started
+## Get started
 
-In order to insert records into a Kafka REST Proxy service, you can run the plugin from the command line or through the configuration file:
+To insert records into a Kafka REST Proxy service, you can run the plugin from the command line or through the configuration file.
 
-### Command Line
+### Command line
 
-The **kafka-rest** plugin, can read the parameters from the command line in two ways, through the **-p** argument \(property\), e.g:
+The Kafka REST plugin can read the parameters from the command line through the `-p` argument (property):
 
 ```shell
 fluent-bit -i cpu -t cpu -o kafka-rest -p host=127.0.0.1 -p port=8082 -m '*'
 ```
 
-### Configuration File
+### Configuration file
 
 In your main configuration file append the following:
 
@@ -45,8 +47,8 @@ In your main configuration file append the following:
 pipeline:
   inputs:
     - name: cpu
-      tag: cpu 
-      
+      tag: cpu
+
   outputs:
     - name: kafka-rest
       match: '*'
@@ -74,4 +76,4 @@ pipeline:
 ```
 
 {% endtab %}
-{% endtabs %}
+{% endtabs %}

vale-styles/FluentBit/Headings.yml

@@ -51,6 +51,8 @@ exceptions:
   - gRPC
   - I
   - InfluxDB
+  - Kafka
+  - Kafka REST
   - Kinesis
   - Kubernetes
   - LaunchDarkly