Added missing descriptions: Chapter 120

mrgarris0n · mrgarris0n · commit b1df1f3e27e2 · 2024-09-16T16:18:27.000+02:00
Signed-off-by: mrgarris0n &lt;gergely.karacsonyi@gmail.com&gt;
diff --git a/doc/_admin-guide/120_Parser/000_Parsing_syslog_messages/000_Syslog_parser_options.md b/doc/_admin-guide/120_Parser/000_Parsing_syslog_messages/000_Syslog_parser_options.md
@@ -1,6 +1,8 @@
 ---
 title: Options of syslog-parser() parsers
 id: adm-parser-opt
+description: >-
+	This section describes the options of the syslog-parser() in {{ site.product.short_name }}.
 ---
 
 The syslog-parser() has the following options:
diff --git a/doc/_admin-guide/120_Parser/001_Parsing_messages_with_comma/000_CSV_parser_options.md b/doc/_admin-guide/120_Parser/001_Parsing_messages_with_comma/000_CSV_parser_options.md
@@ -1,6 +1,8 @@
 ---
 title: Options of CSV parsers
 id: adm-parser-csv-opt
+description: >-
+	This section describes the options of the csv-parser() in {{ site.product.short_name }}.
 ---
 
 The csv-parser() has the following options:
diff --git a/doc/_admin-guide/120_Parser/002_Parsing_key-value_pairs/000_kv_parser_options.md b/doc/_admin-guide/120_Parser/002_Parsing_key-value_pairs/000_kv_parser_options.md
@@ -3,6 +3,8 @@ title: Options of key=value parsers
 parser: kv-parser
 prefix: kv
 id: adm-parser-kv-opt
+description: >-
+	This section describes the options of the kv-parser() in {{ site.product.short_name }}.
 ---
 
 The kv-parser has the following options.
diff --git a/doc/_admin-guide/120_Parser/003_JSON_parser/000_JSON_parser_options.md b/doc/_admin-guide/120_Parser/003_JSON_parser/000_JSON_parser_options.md
@@ -1,6 +1,8 @@
 ---
 title: Options of JSON parsers
 id: adm-parser-json-opt
+description: >-
+	This section describes the options of the json-parser() in {{ site.product.short_name }}.
 ---
  
 The JSON parser has the following options.
diff --git a/doc/_admin-guide/120_Parser/004_XML_parser/000_Limitations.md b/doc/_admin-guide/120_Parser/004_XML_parser/000_Limitations.md
@@ -1,6 +1,8 @@
 ---
 title: Limitations of the XML parsers
 id: adm-parser-xml-lim
+description: >-
+	This section describes the limitations of the xml-parser() in {{ site.product.short_name }}.
 ---
 
 The XML parser comes with certain limitations.
diff --git a/doc/_admin-guide/120_Parser/004_XML_parser/001_XML_Parser_options.md b/doc/_admin-guide/120_Parser/004_XML_parser/001_XML_Parser_options.md
@@ -1,6 +1,8 @@
 ---
 title: Options of the XML parsers
 id: adm-parser-xml-opt
+description: >-
+	This section describes the options of the xml-parser() in {{ site.product.short_name }}.
 ---
 
 ## drop-invalid()
diff --git a/doc/_admin-guide/120_Parser/005_Parsing_dates/000_Date_parser_options.md b/doc/_admin-guide/120_Parser/005_Parsing_dates/000_Date_parser_options.md
@@ -1,6 +1,8 @@
 ---
 title: Options of date-parser() parsers
 id: adm-parser-date-opt
+description: >-
+	This section describes the options of the date-parser() in {{ site.product.short_name }}.
 ---
 
 The date-parser() parser has the following options.
diff --git a/doc/_admin-guide/120_Parser/008_Apache_access_log_parser/000_Apache_parser_options.md b/doc/_admin-guide/120_Parser/008_Apache_access_log_parser/000_Apache_parser_options.md
@@ -3,6 +3,8 @@ title: Options of apache-accesslog-parser() parsers
 parser: apache-accesslog
 prefix: apache
 id: adm-parser-apache-opt
+description: >-
+	This section describes the options of the apache-accesslog-parser() in {{ site.product.short_name }}.
 ---
 
 {% include doc/admin-guide/options/prefix.md %}
diff --git a/doc/_admin-guide/120_Parser/009_Linux_audit_parser/000_Linux_audit_parser_options.md b/doc/_admin-guide/120_Parser/009_Linux_audit_parser/000_Linux_audit_parser_options.md
@@ -3,6 +3,8 @@ title: Options of linux-audit-parser() parsers
 parser: linux-audit
 prefix: auditd
 id: adm-parser-linux-opt
+description: >-
+	This section describes the options of the linux-audit-parser() in {{ site.product.short_name }}.
 ---
 
 The linux-audit-parser() has the following options.
diff --git a/doc/_admin-guide/120_Parser/010_Cisco_parser.md b/doc/_admin-guide/120_Parser/010_Cisco_parser.md
@@ -2,10 +2,10 @@
 title: Cisco parser
 parser: cisco
 id: adm-parser-cisco
+description: >-
+	The Cisco parser can parse the log messages of various Cisco devices.
 ---
 
-The Cisco parser can parse the log messages of various Cisco devices.
-
 {% include doc/admin-guide/parser-intro.md %}
 
 The parser can parse variations of the following
diff --git a/doc/_admin-guide/120_Parser/014_panos_parser/001_Panos_parser_options.md b/doc/_admin-guide/120_Parser/014_panos_parser/001_Panos_parser_options.md
@@ -1,6 +1,8 @@
 ---
 title: PAN-OS parser options
 id: adm-parser-panos-opt
+description: >-
+	This section describes the options of the panos-parser() in {{ site.product.short_name }}.
 ---
 
 The panos-parser() has the following options:
diff --git a/doc/_admin-guide/120_Parser/016_PostgreSQL_csvlog_parser/001_PostgreSQL_parser_options.md b/doc/_admin-guide/120_Parser/016_PostgreSQL_csvlog_parser/001_PostgreSQL_parser_options.md
@@ -1,6 +1,8 @@
 ---
 title: PostgreSQL csvlog parser options
 id: adm-parser-postgresql-opt
+description: >-
+	This section describes the options of the postgresql-csvlog-parser() in {{ site.product.short_name }}.
 ---
 
 The postgresql-csvlog-parser() has the following options:
diff --git a/doc/_admin-guide/120_Parser/017_metrics_probe_parser/000_metrics_probe_options.md b/doc/_admin-guide/120_Parser/017_metrics_probe_parser/000_metrics_probe_options.md
@@ -1,6 +1,8 @@
 ---
 title: 'metrics-probe options'
 id: adm-parser-metrics-opt
+description: >-
+	This section describes the options of the metrics-probe() parser in {{ site.product.short_name }}.
 ---
 
 ## increment()
diff --git a/doc/_admin-guide/120_Parser/020_Fortigate_parser/000_Fortigate_parser_options.md b/doc/_admin-guide/120_Parser/020_Fortigate_parser/000_Fortigate_parser_options.md
@@ -2,6 +2,8 @@
 title: Fortigate parser options
 parser: fortigate
 id: adm-parser-fortigate-opt
+description: >-
+	This section describes the options of the fortigate-parser() in {{ site.product.short_name }}.
 ---
 
 The fortigate-parser() has the following options:
diff --git a/doc/_admin-guide/120_Parser/022_regexp_parser/000_regex_parser_options.md b/doc/_admin-guide/120_Parser/022_regexp_parser/000_regex_parser_options.md
@@ -1,6 +1,8 @@
 ---
 title: Options of Regular expression parsers
 id: adm-parser-regexp-opt
+description: >-
+	This section describes the options of the regexp-parser() in {{ site.product.short_name }}.
 ---
 
 The Regular expression parser has the following options.
diff --git a/doc/_admin-guide/120_Parser/023_db_parser/000_Classifying_log_messages/000_Structure_of_a_patterndb.md b/doc/_admin-guide/120_Parser/023_db_parser/000_Classifying_log_messages/000_Structure_of_a_patterndb.md
@@ -1,6 +1,8 @@
 ---
 title: The structure of the pattern database
 id: adm-parser-db-struct
+description: >-
+	This section describes the structure of a pattern database in {{ site.product.short_name }}.
 ---
 
 The pattern database is organized as follows:
diff --git a/doc/_admin-guide/120_Parser/023_db_parser/000_Classifying_log_messages/001_How_pattern_matching_works.md b/doc/_admin-guide/120_Parser/023_db_parser/000_Classifying_log_messages/001_How_pattern_matching_works.md
@@ -1,6 +1,8 @@
 ---
 title: How pattern matching works
 id: adm-parser-db-match
+description: >-
+	This section describes how pattern matching works in {{ site.product.short_name }}.
 ---
 
 ## Figure 21: Applying patterns
diff --git a/doc/_admin-guide/120_Parser/023_db_parser/001_Using_pattern_databases/README.md b/doc/_admin-guide/120_Parser/023_db_parser/001_Using_pattern_databases/README.md
@@ -1,6 +1,8 @@
 ---
 title: Using pattern databases
 id: adm-parser-db-patterndb
+description: >-
+	This section describes how to use pattern databases in {{ site.product.short_name }}.
 ---
 
 To classify messages using a pattern database, include a db-parser()
diff --git a/doc/_admin-guide/120_Parser/023_db_parser/003_Creating_pattern_databases/001_Pattern_parsers.md b/doc/_admin-guide/120_Parser/023_db_parser/003_Creating_pattern_databases/001_Pattern_parsers.md
@@ -1,6 +1,8 @@
 ---
 title: Pattern parsers of {{ site.product.short_name }}
 id: adm-parser-db-pattern-parsers
+description: >-
+	This section describes the pattern parsers of {{ site.product.short_name }}.
 ---
 
 The following parsers are available in {{ site.product.short_name }}.
diff --git a/doc/_admin-guide/120_Parser/023_db_parser/003_Creating_pattern_databases/002_Whatsnew_in_patterndb_v5.md b/doc/_admin-guide/120_Parser/023_db_parser/003_Creating_pattern_databases/002_Whatsnew_in_patterndb_v5.md
@@ -1,6 +1,8 @@
 ---
 title: "What's new in the {{ site.product.short_name }} pattern database format V5"
 id: adm-parser-db-whatsnew
+description: >-
+	This section describes the differences of V5 and V4 pattern database format in {{ site.product.short_name }}.
 ---
 
 The V5 database format has the following differences compared to the V4
diff --git a/doc/_admin-guide/120_Parser/023_db_parser/003_Creating_pattern_databases/README.md b/doc/_admin-guide/120_Parser/023_db_parser/003_Creating_pattern_databases/README.md
@@ -1,4 +1,6 @@
 ---
 title: Creating pattern databases
 id: adm-parser-db-create
+description: >-
+	This section describes how to create pattern databases in {{ site.product.short_name }}.
 ---
diff --git a/doc/_admin-guide/120_Parser/023_db_parser/004_The_syslog-ng_patterndb_format/000_patterndb/000_ruleset/000_patterns/README.md b/doc/_admin-guide/120_Parser/023_db_parser/004_The_syslog-ng_patterndb_format/000_patterndb/000_ruleset/000_patterns/README.md
@@ -2,17 +2,14 @@
 title: 'Element: patterns container'
 short_title: patterns
 id: adm-parser-db-elem-patterns-ruleset
+description: >-
+	A container element. A \<patterns\> element may contain any number of \<pattern\> elements.
 ---
 
 ## Location
 
 / patterndb / ruleset / patterns
 
-## Description
-
-A container element. A \<patterns\> element may contain any number of
-\<pattern\> elements.
-
 ## Attributes
 
 N/A
diff --git a/doc/_admin-guide/120_Parser/023_db_parser/004_The_syslog-ng_patterndb_format/000_patterndb/000_ruleset/001_rules/000_rule/000_patterns/000_urls/README.md b/doc/_admin-guide/120_Parser/023_db_parser/004_The_syslog-ng_patterndb_format/000_patterndb/000_ruleset/001_rules/000_rule/000_patterns/000_urls/README.md
@@ -2,17 +2,15 @@
 title: 'Element: urls'
 short_title: urls
 id: adm-parser-db-elem-urls
+description: >-
+	An element containing one or more URLs referring to further
+	information about the patterns or the matching log messages. (optional)
 ---
 
 ## Location
 
 / patterndb / ruleset / rules / rule / patterns / urls
 
-## Description
-
-OPTIONAL --- An element containing one or more URLs referring to further
-information about the patterns or the matching log messages.
-
 ## Attributes
 
 N/A
diff --git a/doc/_admin-guide/120_Parser/023_db_parser/004_The_syslog-ng_patterndb_format/000_patterndb/000_ruleset/001_rules/000_rule/000_patterns/001_values/README.md b/doc/_admin-guide/120_Parser/023_db_parser/004_The_syslog-ng_patterndb_format/000_patterndb/000_ruleset/001_rules/000_rule/000_patterns/001_values/README.md
@@ -2,19 +2,17 @@
 title: 'Element: values'
 short_title: values
 id: adm-parser-db-elem-values
+description: >-
+	Name-value pairs that are assigned to messages matching the
+	patterns, for example, the representation of the event in the message
+	according to the Common Event Format (CEF) or Common Event Exchange
+	(CEE). The names can be used as macros to reference the assigned values. (optional)
 ---
 
 ## Location
 
 / patterndb / ruleset / rules / rule / patterns / values
 
-## Description
-
-OPTIONAL --- Name-value pairs that are assigned to messages matching the
-patterns, for example, the representation of the event in the message
-according to the Common Event Format (CEF) or Common Event Exchange
-(CEE). The names can be used as macros to reference the assigned values.
-
 ## Attributes
 
 N/A
diff --git a/doc/_admin-guide/120_Parser/023_db_parser/004_The_syslog-ng_patterndb_format/000_patterndb/000_ruleset/001_rules/000_rule/000_patterns/002_examples/000_example/README.md b/doc/_admin-guide/120_Parser/023_db_parser/004_The_syslog-ng_patterndb_format/000_patterndb/000_ruleset/001_rules/000_rule/000_patterns/002_examples/000_example/README.md
@@ -2,16 +2,14 @@
 title: 'Element: example'
 short_title: example
 id: adm-parser-db-elem-example
+description: >-
+	A container element for a sample log message. (optional)
 ---
 
 ## Location
 
 / patterndb / ruleset / rules / rule / patterns / examples / example
 
-## Description
-
-OPTIONAL --- A container element for a sample log message.
-
 ## Attributes
 
 N/A
diff --git a/doc/_admin-guide/120_Parser/023_db_parser/004_The_syslog-ng_patterndb_format/000_patterndb/000_ruleset/001_rules/000_rule/000_patterns/002_examples/README.md b/doc/_admin-guide/120_Parser/023_db_parser/004_The_syslog-ng_patterndb_format/000_patterndb/000_ruleset/001_rules/000_rule/000_patterns/002_examples/README.md
@@ -2,18 +2,16 @@
 title: 'Element: examples'
 short_title: examples
 id: adm-parser-db-elem-examples
+description: >-
+	A container element for sample log messages that should be
+	recognized by the pattern. These messages can be used also to test the
+	patterns and the parsers. (optional)
 ---
 
 ## Location
 
 / patterndb / ruleset / rules / rule / patterns / examples
 
-## Description
-
-OPTIONAL --- A container element for sample log messages that should be
-recognized by the pattern. These messages can be used also to test the
-patterns and the parsers.
-
 ## Attributes
 
 N/A
diff --git a/doc/_admin-guide/120_Parser/023_db_parser/004_The_syslog-ng_patterndb_format/000_patterndb/000_ruleset/001_rules/000_rule/000_patterns/README.md b/doc/_admin-guide/120_Parser/023_db_parser/004_The_syslog-ng_patterndb_format/000_patterndb/000_ruleset/001_rules/000_rule/000_patterns/README.md
@@ -2,19 +2,17 @@
 title: 'Element: patterns'
 short_title: patterns
 id: adm-parser-db-elem-patterns-rule
+description: >-
+	An element containing the patterns of the rule. If a *\<patterns\>*
+	element contains multiple *\<pattern\>* elements, the class of the
+	*\<rule\>* is assigned to every syslog message matching any of the
+	patterns.
 ---
 
 ## Location
 
 / patterndb / ruleset / rules / rule / patterns
 
-## Description
-
-An element containing the patterns of the rule. If a *\<patterns\>*
-element contains multiple *\<pattern\>* elements, the class of the
-*\<rule\>* is assigned to every syslog message matching any of the
-patterns.
-
 ## Attributes
 
 N/A
diff --git a/doc/_admin-guide/120_Parser/023_db_parser/004_The_syslog-ng_patterndb_format/000_patterndb/000_ruleset/001_rules/000_rule/README.md b/doc/_admin-guide/120_Parser/023_db_parser/004_The_syslog-ng_patterndb_format/000_patterndb/000_ruleset/001_rules/000_rule/README.md
@@ -2,17 +2,15 @@
 title: 'Element: rule'
 short_title: rule
 id: adm-parser-db-elem-rule
+description: >-
+	An element containing message patterns and how a message that matches
+	these patterns is classified.
 ---
 
 ## Location
 
 / patterndb / ruleset / rules / rule
 
-## Description
-
-An element containing message patterns and how a message that matches
-these patterns is classified.
-
 **NOTE:** If the following characters appear in the message, they must be
 escaped in the rule as follows:
 
diff --git a/doc/_admin-guide/120_Parser/023_db_parser/004_The_syslog-ng_patterndb_format/000_patterndb/000_ruleset/001_rules/README.md b/doc/_admin-guide/120_Parser/023_db_parser/004_The_syslog-ng_patterndb_format/000_patterndb/000_ruleset/001_rules/README.md
@@ -2,16 +2,14 @@
 title: 'Element: rules'
 short_title: rules
 id: adm-parser-db-elem-rules
+description: >-
+	A container element for the rules of the ruleset.
 ---
 
 ## Location
 
 / patterndb / ruleset / rules
 
-## Description
-
-A container element for the rules of the ruleset.
-
 ## Attributes
 
 N/A
diff --git a/doc/_admin-guide/120_Parser/023_db_parser/004_The_syslog-ng_patterndb_format/000_patterndb/000_ruleset/002_actions/000_action/000_create_context/README.md b/doc/_admin-guide/120_Parser/023_db_parser/004_The_syslog-ng_patterndb_format/000_patterndb/000_ruleset/002_actions/000_action/000_create_context/README.md
@@ -2,19 +2,17 @@
 title: 'Element: create-context'
 short_title: create-context
 id: adm-parser-db-elem-create-context
+description: >-
+	Creates a new correlation context from the current message
+	and its associated context. This can be used to \"split\" a context. (optional) 
+
+	Available in {{ site.product.short_name }} version 3.8 and later. 
 ---
 
 ## Location
 
 / patterndb / ruleset / actions / action / create-context
 
-## Description
-
-OPTIONAL --- Creates a new correlation context from the current message
-and its associated context. This can be used to \"split\" a context.
-
-Available in {{ site.product.short_name }} version 3.8 and later.
-
 ## Attributes
 
 - *context-id*: OPTIONAL --- An identifier to group related log
diff --git a/doc/_admin-guide/120_Parser/023_db_parser/004_The_syslog-ng_patterndb_format/000_patterndb/000_ruleset/002_actions/000_action/README.md b/doc/_admin-guide/120_Parser/023_db_parser/004_The_syslog-ng_patterndb_format/000_patterndb/000_ruleset/002_actions/000_action/README.md
diff --git a/doc/_admin-guide/120_Parser/023_db_parser/004_The_syslog-ng_patterndb_format/000_patterndb/000_ruleset/002_actions/README.md b/doc/_admin-guide/120_Parser/023_db_parser/004_The_syslog-ng_patterndb_format/000_patterndb/000_ruleset/002_actions/README.md
diff --git a/doc/_admin-guide/120_Parser/023_db_parser/004_The_syslog-ng_patterndb_format/000_patterndb/000_ruleset/003_tags/README.md b/doc/_admin-guide/120_Parser/023_db_parser/004_The_syslog-ng_patterndb_format/000_patterndb/000_ruleset/003_tags/README.md
diff --git a/doc/_admin-guide/120_Parser/023_db_parser/004_The_syslog-ng_patterndb_format/000_patterndb/000_ruleset/README.md b/doc/_admin-guide/120_Parser/023_db_parser/004_The_syslog-ng_patterndb_format/000_patterndb/000_ruleset/README.md
diff --git a/doc/_admin-guide/120_Parser/023_db_parser/004_The_syslog-ng_patterndb_format/000_patterndb/README.md b/doc/_admin-guide/120_Parser/023_db_parser/004_The_syslog-ng_patterndb_format/000_patterndb/README.md
diff --git a/doc/_admin-guide/120_Parser/023_db_parser/README.md b/doc/_admin-guide/120_Parser/023_db_parser/README.md
diff --git a/doc/_admin-guide/120_Parser/024_opentelemetry_parser.md b/doc/_admin-guide/120_Parser/024_opentelemetry_parser.md
