External links refactor (#47)

Fixes: #7 

Added missing links to external_links.yml file
Added some guidelines to yml
Created logical grouping and alphabetical order in yml
Eliminated hardwired URLs from admin guide
Fixed some missing id-s

Author: HofiOne

_data/external_links.yml

@@ -4,6 +4,8 @@ The syslog-ng.conf manual page
 The syslog-ng manual page
 
 >**NOTE:**
->If you experience any problems or need help with syslog-ng OSE, visit the syslog-ng mailing list. \
+>If you experience any problems or need help with syslog-ng OSE, visit
+>the syslog-ng mailing list.
+>  
 >For news and notifications about syslog-ng OSE, visit the syslog-ng blogs.
 {: .notice--info}

_includes/doc/admin-guide/manpages-footnote.md

@@ -2,8 +2,7 @@
 **NOTE:** The {{ page.app }} application is distributed with the syslog-ng OSE
 system logging application, and is usually part of the syslog-ng OSE
 package. The latest version of the syslog-ng OSE application is
-available at the [syslog-ng OSE page](https://syslog-ng.com/).
+available at the syslog-ng OSE page.
 {: .notice--info}
 
-This manual page is only an abstract, for the complete documentation of
-syslog-ng OSE, see the [syslog-ng OSE Documentation page](https://www.syslog-ng.com/).
+This manual page is only an abstract.

_includes/doc/admin-guide/manpages-intro.md

@@ -3,8 +3,7 @@
 |  Type:|      string|
   |Default:|   empty string|
 
-*Description:* Required. This option specifies your [Sumo Logic
-deployment](https://help.sumologic.com/APIs/General-API-Information/Sumo-Logic-Endpoints-and-Firewall-Security).
+*Description:* Required. This option specifies your Sumo Logic deployment.
 
 For details on the deployment() option in the sumologic-http()
 destination\'s declaration, see [[Declaration for the sumologic-http() destination|adm-dest-sumologic-http]].

_includes/doc/admin-guide/options/deployment.md

@@ -1,6 +1,6 @@
 ## keep-alive()
 
-This option configures the forwarding of [gRPC keepalive pings](https://grpc.io/docs/guides/keepalive/) in syslog-ng OSE.
+This option configures the forwarding of gRPC keepalive pings in syslog-ng OSE.
 
 ### max-pings-without-data()
 

_includes/doc/admin-guide/options/gRPC-keep-alive.md

@@ -55,7 +55,7 @@ syslog-ng OSE reload, use the following options:
 
 In the following example, the hook-commands() is used with the network()
 driver and it opens an
-[iptables](https://en.wikipedia.org/wiki/Iptables) port automatically as
+iptables port automatically as
 syslog-ng OSE is started/stopped.
 
 The assumption in this example is that the LOGCHAIN chain is part of a

_includes/doc/admin-guide/options/hook.md

@@ -10,7 +10,7 @@ external Python file. This option has no effect when the Python class is
 provided within the syslog-ng OSE configuration file (in a python{}
 block). You can use the loaders() option to modify the import mechanism
 that imports Python class. For example, that way you can use
-[hy](https://github.com/hylang/hy) in your Python class.
+hy in your Python class.
 
 ```config
 python(class(usermodule.HyParser) loaders(hy))

_includes/doc/admin-guide/options/loaders.md

@@ -6,7 +6,4 @@
 |                  | 1 - at least once (a much slower option than 0) |
 |                  | 2 - exactly once (the slowest option)           |
 
-*Description:* The [Quality of Service (QoS)
-level](https://www.hivemq.com/blog/mqtt-essentials-part-6-mqtt-quality-of-service-levels/)
-in MQTT messaging is an agreement between sender and receiver on the
-guarantee of delivering a message.
+*Description:* The Quality of Service (QoS) level in MQTT messaging is an agreement between sender and receiver on the guarantee of delivering a message.

_includes/doc/admin-guide/options/qos.md

@@ -47,9 +47,8 @@ To ensure at least a best effort level of reliability, One Identity
 recommends that you deploy a relay on the network, close to the source
 devices. With the most reliable hops between the source and the relay,
 you can minimize the risk of losing UDP packets. Once the packet arrives
-at the relay, [syslog-ng OSE](https://syslog-ng.com/blog/upgrading-from-syslog-ng-open-source-to-premium-edition/)
-ensures that the messages are delivered to the central server in a
-reliable manner, based on TCP/TLS.
+at the relay, syslog-ng OSE ensures that the messages are delivered to
+the central server in a reliable manner, based on TCP/TLS.
 
 ### Too many source devices
 

doc/_admin-guide/020_The_concepts_of_syslog-ng/002_Modes_of_operation.md

@@ -14,8 +14,8 @@ code package is under LGPL, the rest is GPL.
 {: .notice--info}
 
 For details about the LGPL and GPL licenses, see
-[[GNU Lesser General Public License|lgpl-license]] and
-[[GNU General Public License|gpl-license]], respectively.
+GNU Lesser General Public License and
+GNU General Public License, respectively.
 
 For clarity, the Documentation is licensed separately.
 For details, see The syslog-ng Open Source Edition Documentation License.

doc/_admin-guide/020_The_concepts_of_syslog-ng/005_Licensing.md

@@ -8,4 +8,4 @@ description: >-
 ---
 
 A tool that can be used to create UNIX clusters is Heartbeat (for details,
-see [this page](http://www.linux-ha.org/wiki/Main_Page/)).
+see the archived page of Linux-HA.

doc/_admin-guide/020_The_concepts_of_syslog-ng/006_High_availability.md

@@ -3,7 +3,7 @@ title: BSD-syslog or legacy-syslog messages
 id: adm-struct-bsd
 description: >-
     This section describes the format of a syslog message, according to the
-    [legacy-syslog or BSD-syslog protocol](https://tools.ietf.org/search/rfc3164).
+    legacy syslog (BSD-syslog) protocol.
 ---
 
 A syslog message consists of the following parts:
@@ -35,7 +35,7 @@ size when using UDP destinations.
 ## The PRI message part
 
 This section describes the PRI message part of a syslog message, according to the
-[legacy-syslog or BSD-syslog protocol](https://tools.ietf.org/search/rfc3164).
+legacy syslog (BSD-syslog) protocol.
 
 The PRI part of the syslog message (known as Priority value) represents
 the Facility and Severity of the message. Facility represents the part
@@ -72,7 +72,7 @@ example:
 
 ## The HEADER message part
 
-This section describes the HEADER message part of a syslog message, according to the [legacy-syslog or BSD-syslog protocol](https://tools.ietf.org/search/rfc3164).
+This section describes the HEADER message part of a syslog message, according to the legacy syslog (BSD-syslog) protocol.
 
 The HEADER message part contains a timestamp and the hostname (without
 the domain name) or the IP address of the device. The timestamp field is
@@ -97,7 +97,7 @@ format. For details, see the ts-format() option in Global options.
 ## The MSG message part
 
 This section describes the MSG message part of a syslog message, according to
-the [legacy-syslog or BSD-syslog protocol](https://tools.ietf.org/search/rfc3164).
+the legacy syslog (BSD-syslog) protocol.
 
 The MSG part contains the name of the program or process that generated
 the message, and the text of the message itself. The MSG part is usually

doc/_admin-guide/020_The_concepts_of_syslog-ng/007_The_structure_of_a_log_message/000_BSD_syslog_messages.md

@@ -3,7 +3,7 @@ title: IETF-syslog messages
 id: adm-struct-ietf
 description: >-
     This section describes the format of a syslog message, according to the
-    [IETF-syslog protocol](https://tools.ietf.org/html/rfc5424). 
+    IETF-syslog protocol. 
 ---
 
 A syslog message consists of the following parts:
@@ -12,7 +12,7 @@ A syslog message consists of the following parts:
 - [[STRUCTURED-DATA|adm-struct-ietf#the-structured-data-message-part]]
 - [[MSG|adm-struct-ietf#the-msg-message-part]]
 
-The following is a sample syslog message (source: <https://tools.ietf.org/html/rfc5424>):
+The following is a sample syslog message [(source)|rfc-5424]:
 
 ><34>1 2003-10-11T22:14:15.003Z mymachine.example.com su - ID47 - BOM'su root' failed for lonvick on /dev/pts/8
 

doc/_admin-guide/020_The_concepts_of_syslog-ng/007_The_structure_of_a_log_message/001_IETF_syslog_messages.md

@@ -7,11 +7,11 @@ description: >-
 
 Currently there are two standard syslog message formats:
 
-- The old standard described in RFC 3164 (also called the BSD-syslog
+- The old standard described in RFC-3164 (also called the BSD-syslog
     or the legacy-syslog protocol): see
     BSD-syslog or legacy-syslog messages.
 
-- The new standard described in RFC 5424 (also called the IETF-syslog
+- The new standard described in RFC-5424 (also called the IETF-syslog
     protocol): see IETF-syslog messages.
 
 - The Enterprise-wide message model or EWMM allows you to deliver

doc/_admin-guide/020_The_concepts_of_syslog-ng/007_The_structure_of_a_log_message/README.md

@@ -53,7 +53,7 @@ dedicated to resolving your issue as soon as possible when you
 experience problems.
 
 For more information about syslog-ng Premium Edition, see
-[The syslog-ng Premium Edition Administration Guide](https://support.oneidentity.com/syslog-ng-premium-edition/).
+The syslog-ng Premium Edition Administration Guide.
 
 ## syslog-ng Store Box, ready-to-use log management appliance
 
@@ -92,9 +92,9 @@ SSB provides a number of features that can add value for your use cases:
 - High availability support to ensure continuous log collection in business-critical environments.
 
 For further details about syslog-ng Store Box, see 
-[The syslog-ng Store Box Administration Guide](https://support.oneidentity.com/syslog-ng-store-box/).
+The syslog-ng Store Box Administration Guide.
 
 ## Upgrading from syslog-ng OSE to syslog-ng PE
 
 If you wish to upgrade from syslog-ng OSE to syslog-ng PE, read the blog
-post [Upgrading from syslog-ng OSE to syslog-ng PE](https://syslog-ng.com/blog/upgrading-from-syslog-ng-open-source-to-premium-edition/) for instructions and tips.
+post Upgrading from syslog-ng OSE to syslog-ng PE for instructions and tips.

doc/_admin-guide/020_The_concepts_of_syslog-ng/011_Commercial_version.md

@@ -12,8 +12,7 @@ and other platforms, see syslog-ng Open Source Edition installation packages.
 
 ## Steps
 
-1. Download the latest version of syslog-ng OSE from
-    [GitHub](https://github.com/syslog-ng/syslog-ng/). The source code
+1. Download the latest version of syslog-ng OSE source code from GitHub. The source code
     is available as a tar.gz archive file.
 
 2. Install the following packages that are required to compile
@@ -23,18 +22,16 @@ and other platforms, see syslog-ng Open Source Edition installation packages.
     - A version of the *gcc* C compiler that properly supports Thread
         Local Storage (TLS), for example, version 4.5.
 
-    - The *GNU flex* lexical analyser generator, [available here](https://github.com/westes/flex).
+    - The GNU flex lexical analyser generator
 
-    - The *bison* parser generator, [available here](http://ftp.gnu.org/gnu/bison/).
+    - The bison parser generator
 
-    - The development files of the *glib* library, [available here](http://freshmeat.net/projects/glib/).
+    - The development files of the glib library
 
-    - The development files of the *Autoconf Archive* package,
-        [available here](http://www.gnu.org/software/autoconf-archive/).
+    - The development files of the Autoconf Archive package
 
     - The syslog-ng OSE application now uses PCRE-type regular
-        expressions by default. It requires the libpcre library package,
-        [available here](https://sourceforge.net/projects/pcre/files/pcre/).
+        expressions by default. It requires the libpcre library package.
 
     - If you want to use the Java-based modules of syslog-ng OSE (for
         example, the Elasticsearch, HDFS, or Kafka destinations), you
@@ -44,7 +41,7 @@ and other platforms, see syslog-ng Open Source Edition installation packages.
             (or newer). You can use OpenJDK or Oracle JDK, other
             implementations are not tested.
 
-        - Install [gradle](https://gradle.org/install) version 2.2.1
+        - Install gradle version 2.2.1
             or newer.
 
         - Set **LD_LIBRARY_PATH** to include the libjvm.so file, for
@@ -57,7 +54,7 @@ and other platforms, see syslog-ng Open Source Edition installation packages.
 
         - If you are behind an HTTP proxy, create a gradle.properties
             under the modules/java-modules/ directory. Set the proxy
-            parameters in the file. For details, see [The Gradle User Guide](https://docs.gradle.org/current/userguide/build_environment.html#sec:gradle_properties_and_system_properties).
+            parameters in the file. For details, see The Gradle User Guide.
 
 3. If you want to post log messages as HTTP requests using the http()
     destination, install the development files of the *libcurl* library.
@@ -66,7 +63,7 @@ and other platforms, see syslog-ng Open Source Edition installation packages.
     the HTTP destination.
 
 4. If you want to use the spoof-source function of syslog-ng, install
-    the development files of the *libnet* library, [available here](http://libnet.sourceforge.net).
+    the development files of the libnet library.
 
 5. If you want to send emails using the smtp() destination, install the
     development files of the *libesmtp* library. This library is not
@@ -77,8 +74,8 @@ and other platforms, see syslog-ng Open Source Edition installation packages.
     library is not needed if you use the \--disable-snmp compile option.
 
 7. If you want to use the */etc/hosts.deny* and */etc/hosts.allow* for
-    TCP access, install the development files of the *libwrap* (also
-    called TCP-wrappers) library, [available here](http://ftp.porcupine.org/pub/security/index.html).
+    TCP access, install the development files of the libwrap (also
+    called TCP-wrappers) library.
 
 8. Enter the new directory and issue the following commands. (If the
     ./configure file does not exist, for example, because you cloned the

doc/_admin-guide/030_Installing_syslog-ng/000_Compiling_syslog-ng_from_source.md

@@ -14,7 +14,7 @@ description: >-
 - For instructions on compiling syslog-ng Open Source Edition from the
     source code, see Compiling syslog-ng from source
 
-- You can use a [syslog-ng docker image](https://syslog-ng.com/blog/central-log-server-docker/).
+- You can use a syslog-ng docker image.
 
     For detailed information on how to run your central log server in Docker and 
-    other Docker-related syslog-ng use cases, see the [Logging in Docker using syslog-ng](https://pages.balabit.com/logging-in-docker-using-syslog-ng.html) white paper.
+    other Docker-related syslog-ng use cases, see the Logging in Docker using syslog-ng white paper.

doc/_admin-guide/030_Installing_syslog-ng/README.md

@@ -205,6 +205,6 @@ processed by syslog-ng OSE or you encounter any issue, you have the
 following options:
 {: .notice--info}
 
-- Search for the error or issue in our [knowledge base](https://support.oneidentity.com/syslog-ng-premium-edition/kb).
-- Check the [following knowledge base articles](https://support.oneidentity.com/syslog-ng-premium-edition/kb?k=troubleshooting&r=Topic%3ATroubleshooting) for further troubleshooting.
-- [Open a support service request](https://support.oneidentity.com/) including the results.
+- Search for the error or issue in our knowledge base.
+- Check the following troubleshooting articles.
+- Open a support service request including the results.

doc/_admin-guide/040_Quick-start_guide/003_Managing_and_checking_syslog-ng_OSE_service_on_Linux.md

@@ -41,7 +41,7 @@ log {
 };
 ```
 
-As a syslog-ng user described on a [mailing list](https://lists.gt.net/gentoo/user/209108):
+As a syslog-ng user described on a Gentoo mailing list:
 
 > Alan McKinnon
 >

doc/_admin-guide/050_The_configuration_file/001_Configuration_syntax.md

@@ -8,9 +8,7 @@ description: >-
     configuration, and exports it as a graph into a JSON structure.
 ---
 
-The resulting JSON file can be converted into [DOT file format](https://
-en.wikipedia.org/wiki/DOT_(graph_description_language)) that visualization
-tools (for example, Graphviz) can use. The package
+The resulting JSON file can be converted into DOT file format that visualization tools (for example, Graphviz) can use. The package
 includes a Python script to convert the exported JSON file into DOT
 format:
 `<syslog-ng-installation-directory>/contrib/scripts/config-graph-json-to-dot.py`

doc/_admin-guide/050_The_configuration_file/006_Modules_in_syslog-ng/002_Visualize_the_configuration.md

@@ -8,7 +8,7 @@ description: >-
 ---
 
 (Such reusable blocks are sometimes called a Source Configuration Library, or
-[SCL](https://www.syslog-ng.com/community/b/blog/posts/creating-your-first-block-for-the-syslog-ng-configuration-library-scl).)
+SCL.)
 Any syslog-ng object can be a block. Use the following syntax to define
 a block:
 

doc/_admin-guide/050_The_configuration_file/007_Managing_complex_syslog-ng_configurations/001_Reusing_config_blocks.md

@@ -3,7 +3,7 @@ title: Arr log source
 short_title: Arr logs
 id: adm-src-arr
 description: >-
-    In syslog-ng OSE 4.7 and later versions it is possible to collect logs of the [Lidarr, Prowlarr, Radarr, Readarr, and Sonarr](https://github.com/Servarr/Wiki) (referred to as “*Arr” or “*Arrs”) applications.
+    In syslog-ng OSE 4.7 and later versions it is possible to collect logs of the Lidarr, Prowlarr, Radarr, Readarr, and Sonarr (referred to as “*Arr” or “*Arrs”) applications.
 ---
 
 The new arr() sources are the following:
@@ -29,4 +29,4 @@ The logging module is stored in the <prefix><module> name-value pair
 
 The prefix can be modified with the `prefix()` option.
 
-This driver is a reusable configuration snippet. For details on using or writing such configuration snippets, see Reusing configuration blocks. The source of this configuration snippet can be accessed on [GitHub](https://github.com/syslog-ng/syslog-ng/blob/master/scl/arr/arr.conf).
+This driver is a reusable configuration snippet. For details on using or writing such configuration snippets, see Reusing configuration blocks. The source of the Arr configuration snippet can be accessed on GitHub.

doc/_admin-guide/060_Sources/025_Arr_logs/README.md

@@ -7,10 +7,8 @@ description: >-
     messages from MQTT brokers.
 ---
 
-The mqtt() source builds on the [MQTT
-protocol](https://www.hivemq.com/mqtt/mqtt-protocol/), and uses its
-[client](https://www.hivemq.com/blog/seven-best-mqtt-client-tools/) and
-[broker](https://www.hivemq.com/hivemq/mqtt-broker/) entities.
+The mqtt() source builds on the MQTT protocol, and uses its
+MQTT client and MQTT broker entities.
 
 **NOTE:** The rest of this chapter and its sections build on your
 familiarity with the MQTT protocol, the concept of client and broker

doc/_admin-guide/060_Sources/060_mqtt/README.md

@@ -3,7 +3,7 @@ title: The working mechanism behind the Proxy Protocol
 id: adm-src-netw-proxy-mech
 description: >-
     This section describes how syslog-ng Open Source Edition (syslog-ng OSE)
-    supports the [Proxy Protocol](https://www.haproxy.com/blog/haproxy/proxy-protocol/).
+    supports the Proxy Protocol.
 ---
 
 ## The working mechanism behind the Proxy Protocol

doc/_admin-guide/060_Sources/070_Network/001_Proxy_protocol_support/000_Proxy_protocol_working_mechanism.md

@@ -9,11 +9,11 @@ description: >-
 ---
 
 Essentially, the load balancer masks the source IP
-unless you enable [Proxy Protocol](https://www.haproxy.com/blog/haproxy/proxy-protocol/)
+unless you enable Proxy Protocol
 support for your proxy TLS transport() to inject information about the original
 connection into the forwarded TCP session.
 
-In syslog-ng OSE version 4.1 and later versions, PROXY protocol v2 (transport(proxied-tcp)) is supported. This protocol is used by network load balancers, such as Amazon Elastic Load Balancer and HAProxy, to carry original source/destination address information, as described in the [Proxy protocol description](https://www.haproxy.org/download/1.8/doc/proxy-protocol.txt).
+In syslog-ng OSE version 4.1 and later versions, PROXY protocol v2 (transport(proxied-tcp)) is supported. This protocol is used by network load balancers, such as Amazon Elastic Load Balancer and HAProxy, to carry original source/destination address information, as described in the Proxy protocol description.
 
 For further details about the working mechanism behind the Proxy
 Protocol support on syslog-ng OSE and the configuration details, see the

doc/_admin-guide/060_Sources/070_Network/001_Proxy_protocol_support/README.md

@@ -5,7 +5,7 @@ id: adm-src-nodejs
 description: >-
     Using the nodejs() driver, syslog-ng OSE can receive application logs
     directly from nodejs applications that use the widespread
-    [Winston](https://github.com/winstonjs/winston) logging API. The
+    Winston logging API. The
     syslog-ng OSE application automatically adds the .nodejs.winston. prefix
     to the name of the fields the extracted from the message.
 ---
@@ -21,8 +21,7 @@ The nodejs() driver is actually a reusable configuration snippet
 configured to receive log messages using the network() driver, and
 process its JSON contents. For details on using or writing such
 configuration snippets, see Reusing configuration blocks.
-You can find the source of the nodejs configuration snippet on
-[GitHub](https://github.com/syslog-ng/syslog-ng/blob/master/scl/nodejs/plugin.conf).
+You can find the source of the nodejs configuration snippet on GitHub.
 
 ### Example: Using the nodejs() driver