Skip to content

Commit 92dceb8

Browse files
committed
syslog-ng name variables in doc guide
Signed-off-by: mrgarris0n <gergely.karacsonyi@gmail.com>
1 parent b9862b5 commit 92dceb8

File tree

2 files changed

+11
-12
lines changed

2 files changed

+11
-12
lines changed

doc/_doc-guide/02_Tools/01_Self_made_tools/01_Tests/README.md

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ macro in the destination definition.
2424
{: .notice--info}
2525

2626
To parse non-syslog messages, for example, JSON, CSV, or other messages,
27-
you can use the built-in parsers of syslog-ng OSE. For details, see
27+
you can use the built-in parsers of {{ site.product.short_name }}. For details, see
2828
[[parser: Parse and segment structured messages]].
2929

3030
`multi line backticked
@@ -33,10 +33,10 @@ text`
3333
Soft macros (sometimes also called name-value pairs) are either
3434
built-in macros automatically generated from the log message (for
3535
example, ${HOST}), or custom user-created macros generated by using
36-
the syslog-ng pattern database or a CSV-parser. The SDATA fields of
36+
the {{ site.product.short_name }} pattern database or a CSV-parser. The SDATA fields of
3737
RFC-5424 formatted log messages become soft macros as well. In
3838
contrast with hard macros, soft macros are writable and can be
39-
modified within syslog-ng OSE, for example, using rewrite rules.
39+
modified within {{ site.product.short_name }}, for example, using rewrite rules.
4040

4141
**WARNING:** \{: .notice--warning\} Test \
4242
for the list of hard and soft macros, see [[Hard versus soft macros]].
@@ -63,7 +63,7 @@ options {
6363

6464
---------------------
6565

66-
Introduction to syslog-ng is a test for pages without description/subtitle, but text part between the title and the first heading which can have tooltips too this way.
66+
Introduction to {{ site.product.short_name }} is a test for pages without description/subtitle, but text part between the title and the first heading which can have tooltips too this way.
6767

6868
Developer guide is a double (page title amd section heading) example with a description/subtitle.
6969

@@ -75,7 +75,7 @@ Test of forced link with anchored ID part [[Install Homebrew|dev-inst-macos#home
7575

7676
1. Same test like above in an enumeration [[Install Homebrew|dev-inst-macos#homebrew]].
7777

78-
**Hint:** Same again in a notice block [[Install Homebrew|dev-inst-macos#homebrew]]. If you you have syslog-ng [[installed via brew|dev-inst-macos#installation]], as a reference, you can check the dependencies of the brew built version using `brew deps syslog-ng`
78+
**Hint:** Same again in a notice block [[Install Homebrew|dev-inst-macos#homebrew]]. If you you have {{ site.product.short_name }} [[installed via brew|dev-inst-macos#installation]], as a reference, you can check the dependencies of the brew built version using `brew deps syslog-ng`
7979
{: .notice--info}
8080

8181
Embedded [link test](https://grpc.io/docs/guides/keepalive/) from a different domain
@@ -155,19 +155,18 @@ For details, see [[The syslog-ng.conf manual page]].
155155

156156
[[The syslog-ng.conf manual page]]
157157

158-
[[The syslog-ng manual page]]
158+
[[The {{ site.product.short_name }} manual page]]
159159

160160
Here comes an include doc/admin-guide/manpages-footnote.md test
161161
{% include doc/admin-guide/manpages-footnote.md %}
162162

163163
When encoding is set in a source (using the encoding() option) and the
164164
message is longer (in bytes) than log-msg-size() in UTF-8
165-
representation, syslog-ng OSE splits the message at an undefined
165+
representation, {{ site.product.short_name }} splits the message at an undefined
166166
location (because the conversion between different encodings is not
167167
trivial).
168168

169-
The following is a simple configuration file for syslog-ng Open
170-
Source Edition that collects incoming log messages and stores them
171-
in a text file. syslog-ng Open Source Edition.
169+
The following is a simple configuration file for {{ site.product.name }} that collects incoming log messages and stores them
170+
in a text file. {{ site.product.name }}.
172171

173172
Aliast testing e.g ${LEVEL} or ${PRIORITY} should work like ${SDATA}

doc/_doc-guide/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,10 @@ id: doc-guide
1313
5. If you modify a file in the `_includes/doc/` directory, it is probably included to multiple parts of the documentation. Make sure that your changes make sense in each context.
1414
6. Modify the files as you need (following our markup conventions). For example, you can add new examples, correct typos, and so on.
1515
7. Validate the files to make sure that the `markdown` is well-formed.
16-
8. Commit and sign off your changes. If your changes apply only to syslog-ng OSE, begin the commit message with the `ose` prefix. If the changes apply only to specific versions, indicate them in the tag, for example, `ose 3.35`
16+
8. Commit and sign off your changes. If your changes apply only to {{ site.product.short_name }}, begin the commit message with the `ose` prefix. If the changes apply only to specific versions, indicate them in the tag, for example, `ose 3.35`
1717
9. Push your changes, for example, `git push origin my-typo-fixes`
1818
10. Submit a pull request.
19-
11. Sign the syslog-ng Open Source Edition Documentation Contributor License Agreement when prompted.
19+
11. Sign the {{ site.product.name }} Documentation Contributor License Agreement when prompted.
2020
12. We will review your contribution and if accepted, integrate to the master branch of the documentation and publish it.
2121

2222
## Basic rules, conventions we try to follow

0 commit comments

Comments
 (0)