Added missing descriptions: Chapter 060

mrgarris0n · mrgarris0n · commit 5d2f58cb158f · 2024-09-16T16:18:27.000+02:00
Signed-off-by: mrgarris0n &lt;gergely.karacsonyi@gmail.com&gt;
diff --git a/doc/_admin-guide/060_Sources/000_Default-network-drivers/000_Default-network-drivers_options.md b/doc/_admin-guide/060_Sources/000_Default-network-drivers/000_Default-network-drivers_options.md
@@ -2,9 +2,11 @@
 title: default-network-drivers() source options
 max_conn_default: 10
 id: adm-src-def-netw-opt
+description: >-
+	This section describes the options of the default-network-drivers() source in {{ site.product.short_name }}.
 ---
 
-The systemd-journal() driver has the following options.
+The default-network-drivers() source has the following options.
 
 {% include doc/admin-guide/options/ca-dir.md %}
 
diff --git a/doc/_admin-guide/060_Sources/010_Internal/000_Internal_options.md b/doc/_admin-guide/060_Sources/010_Internal/000_Internal_options.md
@@ -2,6 +2,8 @@
 title: internal() source options
 log_iw_size: 100
 id: adm-src-int-opt
+description: >-
+	This section describes the options of the internal() source in {{ site.product.short_name }}.
 ---
 
 The internal() driver has the following options:
diff --git a/doc/_admin-guide/060_Sources/020_File/000_File_source_options.md b/doc/_admin-guide/060_Sources/020_File/000_File_source_options.md
@@ -1,6 +1,8 @@
 ---
 title: file() source options
 id: adm-src-file-opt
+description: >-
+	This section describes the options of the file() source in {{ site.product.short_name }}.
 ---
 
 The file() driver has the following options:
diff --git a/doc/_admin-guide/060_Sources/020_File/002_Notes_on_reading_kernel_messages.md b/doc/_admin-guide/060_Sources/020_File/002_Notes_on_reading_kernel_messages.md
@@ -1,10 +1,11 @@
 ---
 title: Notes on reading kernel messages
 id: adm-src-file-note
+description: >-
+	This section describes things to consider when reading kernel messages from various platforms.
 ---
 
-Note the following points when reading kernel messages on various
-platforms.
+Please note the following points:
 
 - The kernel usually sends log messages to a special file (/dev/kmsg
     on BSDs, /proc/kmsg on Linux). The file() driver reads log messages
diff --git a/doc/_admin-guide/060_Sources/030_Wildcard-file/000_Wildcard-file_options.md b/doc/_admin-guide/060_Sources/030_Wildcard-file/000_Wildcard-file_options.md
@@ -2,6 +2,8 @@
 title: wildcard-file() source options
 src: wildcard-file
 id: adm-src-wild-opt
+description: >-
+	This section describes the options of the wildcard-file() source in {{ site.product.short_name }}.
 ---
 
 The wildcard-file() driver has the following options:
diff --git a/doc/_admin-guide/060_Sources/040_Kubernetes/000_Kubernetes_options.md b/doc/_admin-guide/060_Sources/040_Kubernetes/000_Kubernetes_options.md
@@ -1,6 +1,8 @@
 ---
 title: kubernetes() source options
 id: adm-src-k8s-opt
+description: >-
+	This section describes the options of the kubernetes() source in {{ site.product.short_name }}.
 ---
 
 The kubernetes() source has the following options:
diff --git a/doc/_admin-guide/060_Sources/050_Linux-audit/000_Linux-audit_options.md b/doc/_admin-guide/060_Sources/050_Linux-audit/000_Linux-audit_options.md
@@ -3,6 +3,8 @@ title: linux-audit() source options
 fn_source: 'linux-audit'
 fn_logs: 'Linux audit logs'
 id: adm-src-linux-opt
+description: >-
+	This section describes the options of the linux-audit() source in {{ site.product.short_name }}.
 ---
 
 The linux-audit() driver has the following options:
diff --git a/doc/_admin-guide/060_Sources/060_mqtt/000_mqtt_source_prerequisites.md b/doc/_admin-guide/060_Sources/060_mqtt/000_mqtt_source_prerequisites.md
@@ -1,6 +1,8 @@
 ---
 title: Prerequisites to using the mqtt() source
 id: adm-src-mqtt-pre
+description: >-
+	In this chapter you can read about the prerequisites of using the mqtt() source in {{ site.product.short_name }}.
 ---
 
 Using the current implementation of the mqtt() source has the
diff --git a/doc/_admin-guide/060_Sources/060_mqtt/001_mqtt_source_limitations.md b/doc/_admin-guide/060_Sources/060_mqtt/001_mqtt_source_limitations.md
@@ -1,6 +1,8 @@
 ---
 title: Limitations to using the mqtt() source
 id: adm-src-mqtt-lim
+description: >-
+	In this chapter you can read about the limitations of the mqtt() source in {{ site.product.short_name }}.
 ---
 
 Using the mqtt() source of {{ site.product.short_name }} has the following limitations:
diff --git a/doc/_admin-guide/060_Sources/060_mqtt/002_mqtt_source_options.md b/doc/_admin-guide/060_Sources/060_mqtt/002_mqtt_source_options.md
@@ -2,6 +2,8 @@
 title: Options of the mqtt() source
 srv: 'MQTT broker'
 id: adm-src-mqtt-opt
+description: >-
+	This section describes the options of the mqtt() source in {{ site.product.short_name }}.
 ---
 
 The mqtt() source has the following options.
diff --git a/doc/_admin-guide/060_Sources/070_Network/000_Network_source_options.md b/doc/_admin-guide/060_Sources/070_Network/000_Network_source_options.md
@@ -1,6 +1,8 @@
 ---
 title: network() source options
 id: adm-src-netw-opt
+description: >-
+	This section describes the options of the network() source in {{ site.product.short_name }}.
 ---
 
 The network() driver has the following options:
diff --git a/doc/_admin-guide/060_Sources/080_nodejs/000_nodejs_options.md b/doc/_admin-guide/060_Sources/080_nodejs/000_nodejs_options.md
@@ -2,6 +2,8 @@
 title: nodejs() source options
 port_default: '9003'
 id: adm-src-nodejs-opt
+description: >-
+	This section describes the options of the nodejs() source in {{ site.product.short_name }}.
 ---
 
 The nodejs() driver has the following options.
diff --git a/doc/_admin-guide/060_Sources/090_mbox/000_mbox_options.md b/doc/_admin-guide/060_Sources/090_mbox/000_mbox_options.md
@@ -1,6 +1,8 @@
 ---
 title: mbox() source options
 id: adm-src-mbox-opt
+description: >-
+	This section describes the options of the mbox() source in {{ site.product.short_name }}.
 ---
 
 The mbox() driver has the following option.
diff --git a/doc/_admin-guide/060_Sources/100_osquery/000_osquery_source_options.md b/doc/_admin-guide/060_Sources/100_osquery/000_osquery_source_options.md
@@ -1,6 +1,8 @@
 ---
 title: osquery() source options
 id: adm-src-osquery-opt
+description: >-
+	This section describes the options of the osquery() source in {{ site.product.short_name }}.
 ---
 
 The osquery() driver has the following options.
diff --git a/doc/_admin-guide/060_Sources/102_OpenTelemetry/000_opentelemetry_source_options.md b/doc/_admin-guide/060_Sources/102_OpenTelemetry/000_opentelemetry_source_options.md
@@ -1,6 +1,8 @@
 ---
 title: opentelemetry() source options
 id: adm-src-optel-opt
+description: >-
+	This section describes the options of the opentelemetry() source in {{ site.product.short_name }}.
 ---
 
 The following options are available for the `opentelemetry()` source.
diff --git a/doc/_admin-guide/060_Sources/102_OpenTelemetry/README.md b/doc/_admin-guide/060_Sources/102_OpenTelemetry/README.md
@@ -3,7 +3,7 @@ title: 'OpenTelemetry source'
 short_title: OpenTelemetry
 id: adm-src-optel
 description: >-
-    In syslog-ng OSE 4.3 and later versions it is possible to collect logs, metrics and traces from OpenTelemetry clients. For more information see the OpenTelemetry Protocol (OTLP/gRPC).
+    In {{ site.product.short_name }} 4.3 and later versions it is possible to collect logs, metrics and traces from OpenTelemetry clients. For more information see the OpenTelemetry Protocol (OTLP/gRPC).
 ---
 
 In the example below, an OpenTelemetry source and destination are defined. The incoming data is forwarded to a receiver.
diff --git a/doc/_admin-guide/060_Sources/110_Pipe/000_Pipe_source_options.md b/doc/_admin-guide/060_Sources/110_Pipe/000_Pipe_source_options.md
@@ -1,6 +1,8 @@
 ---
 title: pipe() source options
 id: adm-src-pipe-opt
+description: >-
+	This section describes the options of the pipe() source in {{ site.product.short_name }}.
 ---
 
 The pipe driver has the following options:
diff --git a/doc/_admin-guide/060_Sources/120_pacct/000_pacct_options.md b/doc/_admin-guide/060_Sources/120_pacct/000_pacct_options.md
@@ -1,6 +1,8 @@
 ---
 title: pacct() options
 id: adm-src-pacct-opt
+description: >-
+	This section describes the options of the pacct() source in {{ site.product.short_name }}.
 ---
 
 The pacct() driver has the following options:
diff --git a/doc/_admin-guide/060_Sources/130_Program/000_Program_source_options.md b/doc/_admin-guide/060_Sources/130_Program/000_Program_source_options.md
@@ -1,6 +1,8 @@
 ---
 title: program() source options
 id: adm-src-prog-opt
+description: >-
+	This section describes the options of the program() source in {{ site.product.short_name }}.
 ---
 
 {% include doc/admin-guide/options/source-flags.md %}
diff --git a/doc/_admin-guide/060_Sources/140_Python/002_Python_source_options.md b/doc/_admin-guide/060_Sources/140_Python/002_Python_source_options.md
@@ -4,6 +4,8 @@ python_class: MyPythonSource
 class_type: source
 time_reopen: '1'
 id: adm-src-python-opt
+description: >-
+	This section describes the options of the python() and python-fetcher() sources in {{ site.product.short_name }}.
 ---
 
 The python() and python-fetcher() drivers have the following options.
diff --git a/doc/_admin-guide/060_Sources/150_snmptrap/000_snmptrap_options.md b/doc/_admin-guide/060_Sources/150_snmptrap/000_snmptrap_options.md
@@ -3,6 +3,8 @@ title: snmptrap() source options
 fn_source: snmptrapd
 fn_logs: traps
 id: adm-src-snmp-opt
+description: >-
+	This section describes the options of the snmptrap() source in {{ site.product.short_name }}.
 ---
 
 The snmptrap() driver has the following options. Only the filename()
diff --git a/doc/_admin-guide/060_Sources/160_sun-streams/000_sun-streams_options.md b/doc/_admin-guide/060_Sources/160_sun-streams/000_sun-streams_options.md
@@ -1,6 +1,8 @@
 ---
 title: sun-streams() source options
 id: adm-src-sun-opt
+description: >-
+	This section describes the options of the sun-streams() source in {{ site.product.short_name }}.
 ---
 
 The sun-streams() driver has the following options.
diff --git a/doc/_admin-guide/060_Sources/170_Syslog/000_syslog_source_options.md b/doc/_admin-guide/060_Sources/170_Syslog/000_syslog_source_options.md
@@ -1,6 +1,8 @@
 ---
 title: syslog() source options
 id: adm-src-syslog-opt
+description: >-
+	This section describes the options of the syslog() source in {{ site.product.short_name }}.
 ---
 
 The syslog() driver has the following options.
diff --git a/doc/_admin-guide/060_Sources/175_syslog-otlp/000_otlp_source_options.md b/doc/_admin-guide/060_Sources/175_syslog-otlp/000_otlp_source_options.md
@@ -1,6 +1,8 @@
 ---
 title: syslog-ng-otlp() source options
 id: adm-src-otlp-opt
+description: >-
+	This section describes the options of the syslog-ng-otlp() source in {{ site.product.short_name }}.
 ---
 
 The following options are available for the `syslog-ng-otlp()` source.
diff --git a/doc/_admin-guide/060_Sources/180_System/000_System_options.md b/doc/_admin-guide/060_Sources/180_System/000_System_options.md
@@ -1,6 +1,8 @@
 ---
 title: system() source options
 id: adm-src-system-opt
+description: >-
+	This section describes the options of the system() source in {{ site.product.short_name }}.
 ---
 
 The system() driver has the following options:
diff --git a/doc/_admin-guide/060_Sources/190_systemd-journal/000_systemd-journal_options.md b/doc/_admin-guide/060_Sources/190_systemd-journal/000_systemd-journal_options.md
@@ -4,6 +4,8 @@ facility_default: 'local0'
 priority_default: 'notice'
 src: 'systemd-journal()'
 id: adm-src-systemd-journal-opt
+description: >-
+	This section describes the options of the systemd-journal() source in {{ site.product.short_name }}.
 ---
 
 The systemd-journal() driver has the following options:
diff --git a/doc/_admin-guide/060_Sources/200_systemd-syslog/000_systemd-syslog_options.md b/doc/_admin-guide/060_Sources/200_systemd-syslog/000_systemd-syslog_options.md
@@ -1,6 +1,8 @@
 ---
 title: systemd-syslog() source options
 id: adm-src-systemd-syslog
+description: >-
+	This section describes the options of the systemd-syslog() source in {{ site.product.short_name }}.
 ---
 
 The systemd-syslog() driver has the following options:
diff --git a/doc/_admin-guide/060_Sources/210_tcp_tcp6_udp_udp6/000_Convert_tcp_udp_to_network_source.md b/doc/_admin-guide/060_Sources/210_tcp_tcp6_udp_udp6/000_Convert_tcp_udp_to_network_source.md
@@ -3,6 +3,8 @@ title: Change an old source driver to the network() driver
 dors: 'source'
 prefix: 's'
 id: adm-src-tcp-convert
+description: >-
+	This section describes how to convert an old source driver to network() driver in {{ site.product.short_name }}.
 ---
 
 {% include doc/admin-guide/convert-to-network.md %}
diff --git a/doc/_admin-guide/060_Sources/220_unix-stream_unix-dgram/001_unixstream_source_options.md b/doc/_admin-guide/060_Sources/220_unix-stream_unix-dgram/001_unixstream_source_options.md
@@ -3,6 +3,8 @@ title: unix-stream() and unix-dgram() source options
 max_conn_default: '256'
 perm: '0666'
 id: adm-src-unix-opt
+description: >-
+	This section describes the options of the unix-stream() and unix-dgram() sources in {{ site.product.short_name }}.
 ---
 
 These two drivers behave similarly: they open an AF_UNIX socket and
diff --git a/doc/_admin-guide/060_Sources/230_stdin/000_stdin_options.md b/doc/_admin-guide/060_Sources/230_stdin/000_stdin_options.md
@@ -2,6 +2,8 @@
 title: stdin() source options
 src: 'stdin'
 id: adm-src-stdin-opt
+description: >-
+	This section describes the options of the stdin() source in {{ site.product.short_name }}.
 ---
 
 The stdin() driver has the following options:
