Skip to content

Commit b17eb32

Browse files
authored
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
2 parents 0ea38db + ada88aa commit b17eb32

File tree

118 files changed

+1358
-497
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

118 files changed

+1358
-497
lines changed

_data/external_links.yml

Lines changed: 1063 additions & 90 deletions
Large diffs are not rendered by default.

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

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@ The syslog-ng.conf manual page
44
The syslog-ng manual page
55

66
>**NOTE:**
7-
>If you experience any problems or need help with syslog-ng OSE, visit the syslog-ng mailing list. \
7+
>If you experience any problems or need help with syslog-ng OSE, visit
8+
>the syslog-ng mailing list.
9+
>
810
>For news and notifications about syslog-ng OSE, visit the syslog-ng blogs.
911
{: .notice--info}

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

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,7 @@
22
**NOTE:** The {{ page.app }} application is distributed with the syslog-ng OSE
33
system logging application, and is usually part of the syslog-ng OSE
44
package. The latest version of the syslog-ng OSE application is
5-
available at the [syslog-ng OSE page](https://syslog-ng.com/).
5+
available at the syslog-ng OSE page.
66
{: .notice--info}
77

8-
This manual page is only an abstract, for the complete documentation of
9-
syslog-ng OSE, see the [syslog-ng OSE Documentation page](https://www.syslog-ng.com/).
8+
This manual page is only an abstract.

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

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,7 @@
33
| Type:| string|
44
|Default:| empty string|
55

6-
*Description:* Required. This option specifies your [Sumo Logic
7-
deployment](https://help.sumologic.com/APIs/General-API-Information/Sumo-Logic-Endpoints-and-Firewall-Security).
6+
*Description:* Required. This option specifies your Sumo Logic deployment.
87

98
For details on the deployment() option in the sumologic-http()
109
destination\'s declaration, see [[Declaration for the sumologic-http() destination|adm-dest-sumologic-http]].

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
## keep-alive()
22

3-
This option configures the forwarding of [gRPC keepalive pings](https://grpc.io/docs/guides/keepalive/) in syslog-ng OSE.
3+
This option configures the forwarding of gRPC keepalive pings in syslog-ng OSE.
44

55
### max-pings-without-data()
66

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ syslog-ng OSE reload, use the following options:
5555

5656
In the following example, the hook-commands() is used with the network()
5757
driver and it opens an
58-
[iptables](https://en.wikipedia.org/wiki/Iptables) port automatically as
58+
iptables port automatically as
5959
syslog-ng OSE is started/stopped.
6060

6161
The assumption in this example is that the LOGCHAIN chain is part of a

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ external Python file. This option has no effect when the Python class is
1010
provided within the syslog-ng OSE configuration file (in a python{}
1111
block). You can use the loaders() option to modify the import mechanism
1212
that imports Python class. For example, that way you can use
13-
[hy](https://github.com/hylang/hy) in your Python class.
13+
hy in your Python class.
1414

1515
```config
1616
python(class(usermodule.HyParser) loaders(hy))

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

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,4 @@
66
| | 1 - at least once (a much slower option than 0) |
77
| | 2 - exactly once (the slowest option) |
88

9-
*Description:* The [Quality of Service (QoS)
10-
level](https://www.hivemq.com/blog/mqtt-essentials-part-6-mqtt-quality-of-service-levels/)
11-
in MQTT messaging is an agreement between sender and receiver on the
12-
guarantee of delivering a message.
9+
*Description:* The Quality of Service (QoS) level in MQTT messaging is an agreement between sender and receiver on the guarantee of delivering a message.

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

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -47,9 +47,8 @@ To ensure at least a best effort level of reliability, One Identity
4747
recommends that you deploy a relay on the network, close to the source
4848
devices. With the most reliable hops between the source and the relay,
4949
you can minimize the risk of losing UDP packets. Once the packet arrives
50-
at the relay, [syslog-ng OSE](https://syslog-ng.com/blog/upgrading-from-syslog-ng-open-source-to-premium-edition/)
51-
ensures that the messages are delivered to the central server in a
52-
reliable manner, based on TCP/TLS.
50+
at the relay, syslog-ng OSE ensures that the messages are delivered to
51+
the central server in a reliable manner, based on TCP/TLS.
5352

5453
### Too many source devices
5554

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,8 @@ code package is under LGPL, the rest is GPL.
1414
{: .notice--info}
1515

1616
For details about the LGPL and GPL licenses, see
17-
[[GNU Lesser General Public License|lgpl-license]] and
18-
[[GNU General Public License|gpl-license]], respectively.
17+
GNU Lesser General Public License and
18+
GNU General Public License, respectively.
1919

2020
For clarity, the Documentation is licensed separately.
2121
For details, see The syslog-ng Open Source Edition Documentation License.

0 commit comments

Comments
 (0)