Skip to content

Commit 22488e7

Browse files
authored
External link and link alias modifications (#75)
Fixes: #55 - Replaced plaintext RFC links to html in external_links - Created aliases for gRPC keepalive ping(s) - Fixed FQDN alias duplicate ID - Made FQDN alias case insensitive - Created external link for IETF-syslog message format - Eliminated some external link redundancies around IETF-syslog and BSD-syslog - Adjusted markdown to avoid redundant texts.
2 parents 13b6a3d + 4c2671c commit 22488e7

File tree

4 files changed

+31
-22
lines changed

4 files changed

+31
-22
lines changed

_data/external_links.yml

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -432,32 +432,32 @@ welf:
432432

433433
rfc-822:
434434
id: rfc-822
435-
url: https://www.ietf.org/rfc/rfc822.txt
435+
url: https://tools.ietf.org/html/rfc822
436436
title: [ "RFC-822" ]
437437

438438
rfc-3162:
439439
id: rfc-3162
440-
url: https://www.ietf.org/rfc/rfc3162.txt
440+
url: https://tools.ietf.org/html/rfc3162
441441
title: [ "RFC-3162" ]
442442

443443
rfc-3164:
444444
id: rfc-3164
445-
url: https://www.ietf.org/rfc/rfc3164.txt
445+
url: https://tools.ietf.org/html/rfc3164
446446
title: [ "RFC-3164" ]
447447

448448
rfc-3339:
449449
id: rfc-3339
450-
url: https://www.ietf.org/rfc/rfc3339.txt
450+
url: https://tools.ietf.org/html/rfc3339
451451
title: [ "RFC-3339" ]
452452

453453
rfc-3526:
454454
id: rfc-3526
455-
url: https://www.ietf.org/rfc/rfc3526.txt
455+
url: https://tools.ietf.org/html/rfc3526
456456
title: [ "RFC-3526" ]
457457

458458
rfc-4122:
459459
id: rfc-4122
460-
url: https://www.ietf.org/rfc/rfc4122.txt
460+
url: https://tools.ietf.org/html/rfc4122
461461
title: [ "RFC-4122" ]
462462

463463
rfc-4180:
@@ -472,23 +472,23 @@ rfc-4627:
472472

473473
rfc-5424:
474474
id: rfc-5424
475-
url: https://tools.ietf.org/html/rfc5424#page-8
475+
url: https://tools.ietf.org/html/rfc5424
476476
title: [ "RFC-5424" ]
477477

478478
rfc-base64:
479479
id: rfc-base64
480480
url: https://tools.ietf.org/html/rfc4648
481481
title: [ "base64-encode" ]
482482

483-
rfc-bsd-syslog-proto:
484-
id: rfc-bsd-syslog-proto
485-
url: https://www.ietf.org/rfc/rfc3164.txt
486-
title: [ "legacy syslog (BSD-syslog) protocol" ]
483+
rfc-bsd-syslog-msg:
484+
id: rfc-bsd-syslog-msg
485+
url: https://tools.ietf.org/html/rfc3164#section-4.1
486+
title: [ "legacy BSD-syslog message format" ]
487487

488-
rfc-ietf-syslog-proto:
489-
id: rfc-ietf-syslog-proto
490-
url: https://tools.ietf.org/html/rfc5424
491-
title: [ "IETF-syslog" ]
488+
rfc-ietf-syslog-msg:
489+
id: rfc-ietf-syslog-msg
490+
url: https://tools.ietf.org/html/rfc5424#page-8
491+
title: [ "IETF-syslog message format" ]
492492

493493
rfc-octet:
494494
id: rfc-octet

_data/link_aliases.yml

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -89,5 +89,14 @@ adm-temp-macro-ose#week_day_name-c_week_day_name-r_week_day_name-s_week_day_name
8989
adm-temp-macro-ose#year-c_year-r_year-s_year:
9090
aliases: [ "${YEAR}", "${C_YEAR}", "${R_YEAR}", "${S_YEAR}" ]
9191

92-
adm-temp-macro-ose#year-c_year-r_year-s_year:
93-
aliases: [ "[Ff]ully-qualified domain name", "FQDN" ]
92+
adm-about-glossary#fully-qualified-domain-name-fqdn:
93+
aliases: [ "[Ff]ully [Qq]ualified [Dd]omain [Nn]ame", "FQDN" ]
94+
95+
grpc-keep:
96+
aliases: [ "gRPC keepalive pings", "gRPC keepalive ping", "gRPC ping" ]
97+
98+
adm-about-glossary#bsd-syslog-protocol:
99+
aliases: [ "BSD-syslog protocol", "legacy syslog (BSD-syslog) protocol" ]
100+
101+
adm-about-glossary#ietf-syslog-protocol:
102+
aliases: [ "IETF-syslog protocol", "IETF-syslog" ]

_includes/doc/admin-guide/options/log-msg-size.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@
77
length includes the entire message (the data structure and individual
88
fields). The maximal value that can be set is 268435456 bytes (256 MiB).
99

10-
For messages using the IETF-syslog message format (RFC-5424), the maximal
11-
size of the value of an SDATA field is 64 KiB.
10+
For messages using the IETF-syslog message format, the maximal
11+
size of the value of an `SDATA` field is 64 KiB.
1212

1313
**NOTE:** In most cases, log-msg-size() does not need to be set higher than
1414
10 MiB.

doc/_admin-guide/190_The_syslog-ng_manual_pages/001_loggen.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -175,9 +175,9 @@ statistics:
175175

176176
- \--syslog-proto or -P
177177

178-
Use the new IETF-syslog message format as specified in RFC-5424. By
179-
default, loggen uses the legacy BSD-syslog message format (as
180-
described in RFC-3164). See also the \--no-framing option.
178+
Use the new IETF-syslog message format. By
179+
default, loggen uses the legacy BSD-syslog message format.
180+
See also the \--no-framing option.
181181

182182
- \--unix \</path/to/socket\> or -x \</path/to/socket\>
183183

0 commit comments

Comments
 (0)