Review requests implemented

mrgarris0n · mrgarris0n · commit 84696cb3b30c · 2024-05-28T17:05:55.000+02:00
Signed-off-by: mrgarris0n &lt;gergely.karacsonyi@gmail.com&gt;
diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
 <!-- DO NOT ADD frontmatter, this belongs to the GitHub repository only -->
 
-# Welcome to the {{ site.product.short_name }} documentation center source repository
+# Welcome to the syslog-ng OSE documentation center source repository
 
 [gh:gh-doc-pages]: https://syslog-ng.github.io/doc/
 [gh:gh-syslog-ng-doc-issue-tracker]: https://github.com/syslog-ng/doc/issues
@@ -9,15 +9,15 @@
 [ref:admin-guide]: doc/_admin-guide
 [ref:dev-guide]: doc/_dev-guide
 
-Here you can browse, search and contribute to most of the {{ site.product.short_name }} documentation.
+Here you can browse, search and contribute to most of the syslog-ng OSE documentation.
 
 ## [Documentation guide][ref:doc-guide]
 
 If you would like to help us to make our documentation better, this is [how to contribute][ref:doc-guide-contrib].
 
-## [Administrator guide][ref:admin-guide]
+## [Administration guide][ref:admin-guide]
 
-This repository part contains the source code of `The {{ site.product.name }} Administration Guide`.
+This repository part contains the source code of `The syslog-ng OSE Administration Guide`.
 
 ## [Developer guide][ref:dev-guide]
 
diff --git a/_data/external_links.yml b/_data/external_links.yml
@@ -1059,7 +1059,7 @@ slack-web-api:
 slack-webhook-doc:
   id: slack-webhook-doc
   url: https://api.slack.com/incoming-webhooks
-  title: [ "Slack documentation" ]
+  title: [ "Slack webhook documentation" ]
 
 sn-graphite:
   id: sn-graphite
diff --git a/_includes/doc/admin-guide/facility-severity.md b/_includes/doc/admin-guide/facility-severity.md
@@ -2,7 +2,7 @@ The possible Facility values (between 0 and 23) and Severity values
 (between 0 and 7) each correspond to a message type (see **Table 1: syslog Message Facilities**), or a message importance level (see **Table 2:** syslog Message Severities).
 
 **NOTE:** Facility codes may slightly vary between different platforms. The
-{{ site.product.name }} ({{ site.product.short_name }}) application accepts
+{{ site.product.short_name }} application accepts
 Facility codes as numerical values as well.
 {: .notice--info}
 
diff --git a/_includes/doc/admin-guide/notes/not-valid-param.md b/_includes/doc/admin-guide/notes/not-valid-param.md
@@ -1,4 +1,4 @@
 **NOTE:** If the specified parameter value is not a valid value, the
-function ignores it and sends a debug message. However, the ({{ site.product.name }}({{ site.product.short_name }}) application will still send the
+function ignores it and sends a debug message. However, the ({{ site.product.short_name }} application will still send the
 message.
 {: .notice--info}
diff --git a/doc/_admin-guide/010_Introduction_to_syslog-ng/000_What_syslog-ng_is.md b/doc/_admin-guide/010_Introduction_to_syslog-ng/000_What_syslog-ng_is.md
@@ -2,7 +2,7 @@
 title: What {{ site.product.short_name }} is
 id: adm-intro-what
 description: >-
-    The {{ site.product.name }} ({{ site.product.short_name }}) application is a
+    The {{ site.product.short_name }} application is a
     flexible and highly scalable system logging application that is ideal
     for creating centralized and trusted logging solutions.
 ---
diff --git a/doc/_admin-guide/010_Introduction_to_syslog-ng/003_Who_uses_syslog-ng.md b/doc/_admin-guide/010_Introduction_to_syslog-ng/003_Who_uses_syslog-ng.md
@@ -1,5 +1,5 @@
 ---
-title: Who uses syslog-ng?
+title: Who uses {{ site.product.short_name }}?
 id: adm-intro-who
 ---
 
diff --git a/doc/_admin-guide/010_Introduction_to_syslog-ng/004_Supported_platforms.md b/doc/_admin-guide/010_Introduction_to_syslog-ng/004_Supported_platforms.md
@@ -3,7 +3,7 @@ title: Supported platforms
 id: adm-intro-supp
 ---
 
-The {{ site.product.name }} ({{ site.product.short_name }}) application is highly
+The {{ site.product.short_name }} application is highly
 portable and is known to run on a wide range of hardware architectures
 (x86, x86_64, SUN Sparc, PowerPC 32 and 64, Alpha, ARM64) and operating
 systems, including Linux, BSD, Solaris, IBM AIX, HP-UX, macOS,
diff --git a/doc/_admin-guide/020_The_concepts_of_syslog-ng/004_Timezones_and_daylight_saving.md b/doc/_admin-guide/020_The_concepts_of_syslog-ng/004_Timezones_and_daylight_saving.md
@@ -8,7 +8,7 @@ description: >-
 ---
 
 The {{ site.product.short_name }} application supports messages originating from different
-timezones. The original syslog protocol (RFC3-164) does not include
+timezones. The original syslog protocol (RFC3-3164) does not include
 timezone information, but {{ site.product.short_name }} provides a solution by extending the
 syslog protocol to include the timezone in the log messages. The
 {{ site.product.short_name }} application also enables administrators to supply timezone
diff --git a/doc/_admin-guide/020_The_concepts_of_syslog-ng/006_High_availability.md b/doc/_admin-guide/020_The_concepts_of_syslog-ng/006_High_availability.md
@@ -2,10 +2,9 @@
 title: High availability support
 id: adm-conc-ha
 description: >-
-    Multiple {{ site.product.short_name }} servers can be run in fail-over mode. The syslog-ng
-    application does not include any internal support for this, as
+    Multiple {{ site.product.short_name }} servers can be run in fail-over mode. The {{ site.product.short_name }} application does not include any internal support for this, as
     clustering support must be implemented on the operating system level. 
 ---
 
 A tool that can be used to create UNIX clusters is Heartbeat (for details,
-see the archived page of Linux-HA.
+see the archived page of Linux-HA).
diff --git a/doc/_admin-guide/020_The_concepts_of_syslog-ng/007_The_structure_of_a_log_message/000_BSD_syslog_messages.md b/doc/_admin-guide/020_The_concepts_of_syslog-ng/007_The_structure_of_a_log_message/000_BSD_syslog_messages.md
@@ -25,7 +25,7 @@ The message corresponds to the following format:
 The different parts of the message are explained in the following
 sections.
 
-**NOTE:** The {{ site.product.name }} ({{ site.product.short_name }}) application
+**NOTE:** The {{ site.product.short_name }} application
 supports longer messages as well. For details, see the log-msg-size()
 option in Global options.
 However, it is not recommended to enable messages larger than the packet
@@ -89,7 +89,7 @@ the local time in the *Mmm dd hh:mm:ss* format, where:
     24-hour format. Valid entries are between 00 and 23, inclusive. The
     minute (mm) and second (ss) entries are between 00 and 59 inclusive.
 
-**NOTE:** The {{ site.product.name }} ({{ site.product.short_name }}) application
+**NOTE:** The {{ site.product.short_name }} application
 supports other timestamp formats as well, like ISO, or the PIX extended
 format. For details, see the ts-format() option in Global options.
 {: .notice--info}
diff --git a/doc/_admin-guide/030_Installing_syslog-ng/001_Compiling_options.md b/doc/_admin-guide/030_Installing_syslog-ng/001_Compiling_options.md
@@ -119,7 +119,7 @@ compiling options.
 
 - *\--with-embedded-crypto* If this option is set, the crypto library
     is linked directly into libsyslog-ng: the sources of
-    libsyslog-ng-crypto will be appended to the lib{{ site.product.short_name }} sources,
+    libsyslog-ng-crypto will be appended to the libsyslog-ng sources,
     and -crypto is not built.
 
 - *\--with-ivykis* Specifies which ivykis implementation to use
diff --git a/doc/_admin-guide/040_Quick-start_guide/003_Managing_and_checking_syslog-ng_OSE_service_on_Linux.md b/doc/_admin-guide/040_Quick-start_guide/003_Managing_and_checking_syslog-ng_OSE_service_on_Linux.md
@@ -3,7 +3,7 @@ title: Managing and checking {{ site.product.short_name }} service on Linux
 id: adm-qs-service
 description: >-
     This section describes how to start, stop and check the status of
-    {{ site.product.name }} ({{ site.product.short_name }}) service on Linux.
+    {{ site.product.short_name }} service on Linux.
 ---
 
 ## Starting {{ site.product.short_name }}
diff --git a/doc/_admin-guide/060_Sources/070_Network/001_Proxy_protocol_support/000_Proxy_protocol_working_mechanism.md b/doc/_admin-guide/060_Sources/070_Network/001_Proxy_protocol_support/000_Proxy_protocol_working_mechanism.md
@@ -2,7 +2,7 @@
 title: The working mechanism behind the Proxy Protocol
 id: adm-src-netw-proxy-mech
 description: >-
-    This section describes how {{ site.product.name }} ({{ site.product.short_name }})
+    This section describes how {{ site.product.short_name }}
     supports the Proxy Protocol.
 ---
 
diff --git a/doc/_admin-guide/070_Destinations/090_http_nonjava/002_Azure_auth_header_plugin.md b/doc/_admin-guide/070_Destinations/090_http_nonjava/002_Azure_auth_header_plugin.md
@@ -2,11 +2,11 @@
 title: The Azure auth header plugin
 id: adm-dest-http-nonjava-azure
 description: >-
-  This section describes the {{ site.product.name }} ({{ site.product.short_name }})
+  This section describes the {{ site.product.short_name }}
   application's Azure auth header plugin.
 
   For more information about modules in {{ site.product.short_name }}, see
-  Modules in {{ site.product.name }} ({{ site.product.short_name }}).
+  Modules in {{ site.product.short_name }}.
 ---
 
 ## The Azure auth header plugin
diff --git a/doc/_admin-guide/070_Destinations/090_http_nonjava/003_Python_http_header_plugin.md b/doc/_admin-guide/070_Destinations/090_http_nonjava/003_Python_http_header_plugin.md
@@ -2,11 +2,11 @@
 title: The Python HTTP header plugin
 id: adm-dest-http-nonjava-python
 description: >-
-    This section describes the {{ site.product.name }} ({{ site.product.short_name }})
+    This section describes the {{ site.product.short_name }}
     application's Python HTTP header plugin.
 
     For more information about modules in {{ site.product.short_name }}, see
-    Modules in {{ site.product.name }} ({{ site.product.short_name }}).
+    Modules in {{ site.product.short_name }}.
 ---
 
 ## The Python HTTP header plugin
diff --git a/doc/_admin-guide/070_Destinations/130_MongoDB/README.md b/doc/_admin-guide/070_Destinations/130_MongoDB/README.md
@@ -29,7 +29,7 @@ The {{ site.product.short_name }} mongodb() driver is compatible with MongoDB se
 version 1.4 and newer.
 
 **NOTE:** Prior to version 4.0, {{ site.product.short_name }} handled all data as strings, and allowed the strings to be converted into other types of data that only data formats of certain destinations supported.
-In {{ site.product.short_name }} 4.0 and later versions, each name-value pair is a (name, type, value) triplet, and several components of {{ site.product.short_name }} 4.0 support this format. For details, see [Specifying data types in value-pairs](./000_Specifying_data_types.md).
+In {{ site.product.short_name }} 4.0 and later versions, each name-value pair is a (name, type, value) triplet, and several components of {{ site.product.short_name }} 4.0 support this format. For details, see Specifying data types in value-pairs.
 {: .notice--info}
 
 **NOTE:** By default, {{ site.product.short_name }} handles every message field as a string.
diff --git a/doc/_admin-guide/070_Destinations/230_Slack/000_Slack_options.md b/doc/_admin-guide/070_Destinations/230_Slack/000_Slack_options.md
@@ -116,17 +116,15 @@ documentation](https://api.slack.com/docs/message-attachments).
 app. This URL must also include the authentication token that {{ site.product.short_name }} uses to authenticate to Slack. For example:
 **https://hooks.slack.com/services/T00000000/B00000000/XXXXXXXXXXXXXXXXXXXXXXXX**
 
-For details, see the [Slack documentation about Incoming
-Webhooks](https://api.slack.com/incoming-webhooks).
+For details, see the Slack webhook documentation.
 
 ## image-url()
 
 |  Type:|      URL|
 |  Default:|   None|
 
 *Description:* A hyperlink for an image. For details, see the
-[image_url option in the Slack
-documentation](https://api.slack.com/docs/message-attachments).
+image_url option in the Slack API documentation.
 
 {% include doc/admin-guide/options/log-fifo-size.md %}
 
@@ -138,8 +136,7 @@ documentation](https://api.slack.com/docs/message-attachments).
 |  Default:  | None|
 
 *Description:* The text that appears above the attachment block. For
-details, see the [pretext option in the Slack
-documentation](https://api.slack.com/docs/message-attachments).
+details, see the pretext option in the Slack API documentation.
 
 {% include doc/admin-guide/options/retries.md %}
 
@@ -165,8 +162,7 @@ sslv2, sslv3, tlsv1, tlsv1_0, tlsv1_1, tlsv1_2, tlsv1_3.
 |  Default:|   None|
 
 *Description:* A hyperlink for a thumbnail image. For details, see the
-[thumb\_url option in the Slack
-documentation](https://api.slack.com/docs/message-attachments).
+thumb_url option in the Slack API documentation.
 
 ## timeout()
 
@@ -183,18 +179,16 @@ in version 3.11 and later.
 |  Type:      string or template|
 |  Default:   None|
 
-*Description:* The message title in Slack. For details, see the [title
-option in the Slack
-documentation](https://api.slack.com/docs/message-attachments).
+*Description:* The message title in Slack. For details, see the title
+option in the Slack API documentation.
 
 ## title-link()
 
 |  Type:|      URL|
 |  Default:|   None|
 
 *Description:* A hyperlink for the message title in Slack. For details,
-see the [title_link option in the Slack
-documentation](https://api.slack.com/docs/message-attachments).
+see the title_link option in the Slack API documentation.
 
 {% include doc/admin-guide/options/user-agent.md %}
 
diff --git a/doc/_admin-guide/070_Destinations/230_Slack/README.md b/doc/_admin-guide/070_Destinations/230_Slack/README.md
@@ -50,7 +50,7 @@ You can find the source of the Slack configuration snippet on GitHub.
 
 To send messages and notifications from {{ site.product.short_name }} to Slack, you must
 create a Slack app and a Webhook that {{ site.product.short_name }} can use. For
-details, see the [[Slack documentation|slack-webhook-doc]].
+details, see the Slack webhook documentation.
 
 ### Example: Using the slack() driver
 
diff --git a/doc/_admin-guide/070_Destinations/290_Sumologic/README.md b/doc/_admin-guide/070_Destinations/290_Sumologic/README.md
@@ -4,7 +4,7 @@ title: 'Sumo Logic destinations: sumologic-http() and
 short_title: sumologic
 id: adm-dest-sumologic
 description: >-
-    From version 3.27.1, the {{ site.product.name }} ({{ site.product.short_name }})
+    From version 3.27.1, the {{ site.product.short_name }}
     application can send log messages to Sumo Logic,
     a cloud-based log management and security analytics service, by
     using the sumologic-http() and sumologic-syslog() destinations.
diff --git a/doc/_admin-guide/080_Log/020_Buffering/002_How_to_get_information/000_Information.md b/doc/_admin-guide/080_Log/020_Buffering/002_How_to_get_information/000_Information.md
@@ -3,7 +3,7 @@ title: Information about disk-buffer files
 id: adm-log-diskbuff-info
 description: >-
     This section describes information about disk-buffer files used in
-    {{ site.product.name }} ({{ site.product.short_name }}).
+    {{ site.product.short_name }}.
 ---
 
 The following list contains information about how disk-buffer files are
diff --git a/doc/_admin-guide/080_Log/020_Buffering/002_How_to_get_information/001_Status_information.md b/doc/_admin-guide/080_Log/020_Buffering/002_How_to_get_information/001_Status_information.md
@@ -3,7 +3,7 @@ title: Getting the status information of disk-buffer files
 id: adm-log-diskbuff-status
 description: >-
     This section describes getting the status information of the disk-buffer
-    files used in {{ site.product.name }} ({{ site.product.short_name }}).
+    files used in {{ site.product.short_name }}.
 ---
 
 ## Command syntax
diff --git a/doc/_admin-guide/080_Log/020_Buffering/002_How_to_get_information/002_List.md b/doc/_admin-guide/080_Log/020_Buffering/002_How_to_get_information/002_List.md
@@ -3,7 +3,7 @@ title: Getting the list of disk-buffer files
 id: adm-log-diskbuff-list
 description: >-
     This section describes getting the list of disk-buffer files used in
-    {{ site.product.name }}({{ site.product.short_name }}).
+    {{ site.product.short_name }}.
 ---
 
 The {{ site.product.short_name }} application stores information (namely, the IP:PORT or
diff --git a/doc/_admin-guide/080_Log/020_Buffering/002_How_to_get_information/003_Content.md b/doc/_admin-guide/080_Log/020_Buffering/002_How_to_get_information/003_Content.md
@@ -3,7 +3,7 @@ title: Printing the content of disk-buffer files
 id: adm-log-diskbuff-content
 description: >-
     This section describes printing the content of the disk-buffer files
-    used in {{ site.product.name }}({{ site.product.short_name }}).
+    used in {{ site.product.short_name }}.
 ---
 
 ## Command syntax
diff --git a/doc/_admin-guide/080_Log/020_Buffering/002_How_to_get_information/005_How_to_process_orphan_diskbuffer.md b/doc/_admin-guide/080_Log/020_Buffering/002_How_to_get_information/005_How_to_process_orphan_diskbuffer.md
@@ -4,7 +4,7 @@ short_title: How to process messages from an orphan disk-buffer file
 id: adm-log-diskbuff-process
 description: >-
     This section describes how to read messages from an orphan disk-buffer
-    file by using a separate {{ site.product.name }} ({{ site.product.short_name }})
+    file by using a separate {{ site.product.short_name }}
     process running parallel to the already running {{ site.product.short_name }} instance.
 ---
 
diff --git a/doc/_admin-guide/080_Log/020_Buffering/002_How_to_get_information/README.md b/doc/_admin-guide/080_Log/020_Buffering/002_How_to_get_information/README.md
@@ -3,7 +3,7 @@ title: How to get information about disk-buffer files
 id: adm-log-diskbuff
 description: >-
     This section describes how to get information about disk-buffer files
-    used in {{ site.product.name }} ({{ site.product.short_name }}).
+    used in {{ site.product.short_name }}.
 ---
 
 **NOTE:** While reading this section, consider that the default installation
diff --git a/doc/_admin-guide/120_Parser/007_Parsing_tags.md b/doc/_admin-guide/120_Parser/007_Parsing_tags.md
@@ -2,7 +2,7 @@
 title: Parsing tags
 id: adm-parser-tags
 description: >-
-    The {{ site.product.name }} ({{ site.product.short_name }}) application can tag
+    The {{ site.product.short_name }} application can tag
     log messages, and can include these tags in the log messages, as
     described in Tagging messages can parse these tags from the incoming messages
     and re-tag them. That way if you add tags to a log message on a {{ site.product.short_name }}
diff --git a/doc/_admin-guide/120_Parser/014_panos_parser/000_Message_format.md b/doc/_admin-guide/120_Parser/014_panos_parser/000_Message_format.md
@@ -3,7 +3,7 @@ title: Message format parsed by panos-parser()
 id: adm-parser-panos-format
 description: >-
     This section illustrates the most commonly used PAN-OS log format on the
-    {{ site.product.name }} ({{ site.product.short_name }}) side.
+    {{ site.product.short_name }} side.
 ---
 
 For information about customizing log format on the PAN-OS side, see
diff --git a/doc/_admin-guide/120_Parser/014_panos_parser/README.md b/doc/_admin-guide/120_Parser/014_panos_parser/README.md
@@ -11,7 +11,7 @@ description: >-
     a data structure that requires additional parsing.
 ---
 
-The panos-parser() of {{ site.product.name }} ({{ site.product.short_name }})
+The panos-parser() of {{ site.product.short_name }}
 solves this problem, and can separate PAN-OS log messages to name-value
 pairs.
 
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
@@ -39,8 +39,8 @@ N/A
 
     NOTE: If the \<pattern\> element of a ruleset is not specified,
     {{ site.product.short_name }} will use this ruleset as a fallback ruleset: it will
-    apply the ruleset to messages that have an empty PROGRAM header, or
-    if none of the program patterns matched the PROGRAM header of the
+    apply the ruleset to messages that have an empty ${PROGRAM} header, or
+    if none of the program patterns matched the ${PROGRAM} header of the
     incoming message.
 
 ### Example
diff --git a/doc/_admin-guide/180_Best_practices_and_examples/005_Load_balancing_logs/000_Round_robin.md b/doc/_admin-guide/180_Best_practices_and_examples/005_Load_balancing_logs/000_Round_robin.md
@@ -4,7 +4,7 @@ short_title: Load balancing with round robin
 id: adm-pract-round-robin
 description: >-
   This section describes a round robin load balancing method based on the
-  R_MSEC macro of {{ site.product.name }} ({{ site.product.short_name }}) to load
+  R_MSEC macro of {{ site.product.short_name }} to load
   balance your logs between multiple {{ site.product.short_name }} destinations.
 ---
 
@@ -18,7 +18,7 @@ For more information about the R_MSEC macro and further macros of
 ## Example: round robin load balancing between multiple destinations
 
 The following example is a round-robin load balancing method, based on
-{{ site.product.short_name }}'s R_MSEC macro.
+${R_MSEC} macro of {{ site.product.short_name }}.
 
 ```config
 destination d_lb_network { 
diff --git a/doc/_admin-guide/180_Best_practices_and_examples/005_Load_balancing_logs/001_msec_hashing.md b/doc/_admin-guide/180_Best_practices_and_examples/005_Load_balancing_logs/001_msec_hashing.md
@@ -5,7 +5,7 @@ id: adm-pract-msec
 description: >-
   This section describes a configuration generator for the load balancing
   method based on MSEC hashing to load balance your logs between multiple
-  {{ site.product.name }} ({{ site.product.short_name }}) destinations.
+  {{ site.product.short_name }} destinations.
 ---
 
 ![]({{ site.baseurl}}/assets/images/caution.png) **CAUTION:**
diff --git a/doc/_admin-guide/180_Best_practices_and_examples/005_Load_balancing_logs/README.md b/doc/_admin-guide/180_Best_practices_and_examples/005_Load_balancing_logs/README.md
@@ -3,7 +3,7 @@ title: Load balancing logs between multiple destinations
 id: adm-pract-load
 description: >-
     These sections describe a method of load balancing logs between multiple
-    {{ site.product.name }} ({{ site.product.short_name }}) destinations. The first
+    {{ site.product.short_name }} destinations. The first
     subsection describes the round robin load balancing method based on the
     R_MSEC macro of {{ site.product.short_name }}, while the second subsection describes a
     configuration generator that you can use as an alternative to using the
diff --git a/doc/_admin-guide/200_About/002_Glossary.md b/doc/_admin-guide/200_About/002_Glossary.md
@@ -335,7 +335,7 @@ A host running {{ site.product.short_name }} in client mode.
 
 ### {{ site.product.name }}
 
-The {{ site.product.name }} ({{ site.product.short_name }}) application is a flexible
+The {{ site.product.short_name }} application is a flexible
 and highly scalable system logging application that is ideal for creating
 centralized and trusted logging solutions, for more, see What {{ site.product.short_name }} is.
 
diff --git a/doc/_dev-guide/chapter_2/section_3.md b/doc/_dev-guide/chapter_2/section_3.md
