Skip to content

Commit 81851c2

Browse files
zsoltgyulai94zsoltgyulai94
authored
Merge branch 'master' into doc-hypr-audit
2 parents c5b2abb + 2cdd0b2 commit 81851c2

File tree

20 files changed

+278
-51
lines changed

20 files changed

+278
-51
lines changed

‎README.md

Lines changed: 7 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -2,29 +2,22 @@
22

33
# Welcome to the syslog-ng OSE documentation center source repository
44

5-
[gh:gh-doc-pages]: https://syslog-ng.github.io/doc/
6-
[gh:gh-syslog-ng-doc-issue-tracker]: https://github.com/syslog-ng/doc/issues
7-
[ref:doc-guide]: doc/_doc-guide
8-
[ref:doc-guide-contrib]: doc/_doc-guide/README.md#how-to-contribute-to-the-documentation
9-
[ref:admin-guide]: doc/_admin-guide
10-
[ref:dev-guide]: doc/_dev-guide
11-
125
Here you can browse, search and contribute to most of the syslog-ng OSE documentation.
136

14-
## [Documentation guide][ref:doc-guide]
7+
## [Documentation guide](https://syslog-ng.github.io/doc-guide/README)
158

16-
If you would like to help us to make our documentation better, this is [how to contribute][ref:doc-guide-contrib].
9+
If you would like to help us to make our documentation better, this is [how to contribute](https://syslog-ng.github.io/doc-guide/README#how-to-contribute-to-the-documentation).
1710

18-
## [Administration guide][ref:admin-guide]
11+
## [Administration guide](https://syslog-ng.github.io/admin-guide/README)
1912

2013
This repository part contains the source code of `The syslog-ng OSE Administration Guide`.
2114

22-
## [Developer guide][ref:dev-guide]
15+
## [Developer guide](https://syslog-ng.github.io/dev-guide/README)
2316

24-
Do you like adding your idea, bug-fix to the fabolous syslog-ng? Help others to do the same, share your knwowledge in the [developer guide][ref:dev-guide].
17+
Do you like adding your idea, bug-fix to the fabolous syslog-ng? Help others to do the same, share your knwowledge in the [developer guide](https://syslog-ng.github.io/dev-guide/README).
2518

26-
## [Generated document][gh:gh-doc-pages]
19+
## [Generated document](https://syslog-ng.github.io/)
2720

2821
[![Deploy Jekyll site to Pages](https://github.com/syslog-ng/syslog-ng.github.io/actions/workflows/jekyll-gh-pages.yml/badge.svg)](https://github.com/syslog-ng/syslog-ng.github.io/actions/workflows/jekyll-gh-pages.yml)
2922

30-
We use github to track all of the [documentation issues][gh:gh-syslog-ng-doc-issue-tracker]
23+
We use github to track all of the [documentation issues](https://github.com/syslog-ng/syslog-ng.github.io/issues)

‎_data/link_aliases.yml

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
#
2+
# Enclose the `aliases` strings inside / and / to use ruby regexp.
3+
# Any not enclosed strings will be matched exactly like written.
4+
#
15

26
adm-temp-macro-ose:
37
aliases: [ "/[Mm]acros/" ]
@@ -94,3 +98,9 @@ adm-about-glossary#bsd-syslog-protocol:
9498

9599
adm-about-glossary#ietf-syslog-protocol:
96100
aliases: [ "IETF-syslog protocol", "IETF-syslog" ]
101+
102+
adm-src-wild:
103+
aliases: [ "/wildcard-file(?:\\(\\))? source[s]?/" ]
104+
105+
adm-src-file:
106+
aliases: [ "/file(?:\\(\\))? source[s]?/" ]

‎_data/navigation.yml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -142,8 +142,10 @@ admin-guide-nav:
142142
subnav:
143143
- title: "Notes on reading kernel messages"
144144
url: /admin-guide/060_Sources/020_File/000_Notes_on_reading_kernel_messages
145+
- title: "How file sources are followed"
146+
url: /admin-guide/060_Sources/020_File/001_File_following
145147
- title: "file() source options"
146-
url: /admin-guide/060_Sources/020_File/001_File_source_options
148+
url: /admin-guide/060_Sources/020_File/002_File_source_options
147149
- title: "Arr logs"
148150
url: /admin-guide/060_Sources/025_Arr_logs/README
149151
subnav:

‎_includes/doc/admin-guide/options/filter-severity.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
2+
| Numerical Value | Equivalent Named Values |
3+
|----------------:|-------------------------|
4+
| 0 | emergency, emerg, panic |
5+
| 1 | alert |
6+
| 2 | critical, crit |
7+
| 3 | error, err |
8+
| 4 | warning, warn |
9+
| 5 | notice |
10+
| 6 | informational, info |
11+
| 7 | debug |
12+
13+
Both numerical and named values are equally valid

‎_includes/doc/admin-guide/options/follow-freq.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,10 @@
55

66
*Description:* Indicates that the source should be checked periodically.
77
This is useful for files which always indicate readability, even though
8-
no new lines were appended. If this value is higher than zero, syslog-ng
9-
will not attempt to use poll() on the file, but checks whether the file
10-
changed every time the follow-freq() interval (in seconds) has elapsed.
8+
no new lines were appended (e.g. regular file system files). If this value
9+
is higher than zero, syslog-ng will not attempt to use ivykis file change
10+
notification methods on the file (poll(), epoll(), etc.), but checks whether
11+
the file changed every time the follow-freq() interval (in seconds) has elapsed.\
1112
Floating-point numbers (for example, **1.5**) can be used as well.
13+
14+
{% include doc/admin-guide/warnings/file-source-follow-warning.md %}

‎_includes/doc/admin-guide/options/source-flags.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -117,6 +117,17 @@
117117
destination. For details on multithreading, see
118118
Multithreading and scaling in {{ site.product.short_name }}.
119119
120+
If a parsing or syntax error occurs, use `"threaded"` nested in quotation marks.
121+
122+
```config
123+
flags(
124+
validate-utf8
125+
"threaded"
126+
store-raw-message
127+
)
128+
```
129+
130+
120131
**NOTE:** The file destination uses multiple threads only if the
121132
destination filename contains macros.
122133
{: .notice--info}

‎_includes/doc/admin-guide/warnings/dotdot-stringonly.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
2+
![]({{ site.baseurl}}/assets/images/caution.png) **CAUTION:**
3+
The `..` notation can only be used with named values. Using it with numerical values is not supported.
4+
{: .notice--warning}

‎_includes/doc/admin-guide/warnings/file-source-follow-warning.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
![]({{ site.baseurl}}/assets/images/caution.png) **CAUTION:** As the follow-freq(), the monitor-method(), and the monitor-freq() options could have performance penalty effects, it is important to understand how the file and directory monitoring operates depending on these values. For details, refer to How content changes are followed in file() and wildcard-file() sources.
2+
{: .notice--warning}

‎_sass/minimal-mistakes/minimal-mistakes/_tables.scss

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,9 @@ th {
3030
td {
3131
padding: 0.5em;
3232
border-bottom: 1px solid mix(#000, $border-color, 25%);
33+
&.right-edged-col {
34+
border-right: 1px solid mix(#000, $border-color, 25%);
35+
}
3336
}
3437

3538
tr,

‎doc/_admin-guide/060_Sources/020_File/001_File_source_options.md renamed to ‎doc/_admin-guide/060_Sources/020_File/000_File_source_options.md

File renamed without changes.

0 commit comments

Comments
 (0)