-
Notifications
You must be signed in to change notification settings - Fork 7
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Added the first version of the doc tools test playground page (#28)
Added some other page link fixes, external link fixes Signed-off-by: Hofi <[email protected]>
- Loading branch information
Showing
8 changed files
with
278 additions
and
108 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
154 changes: 154 additions & 0 deletions
154
doc/_doc-guide/02_Tools/01_Self_made_tools/01_Tests/README.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,154 @@ | ||
--- | ||
title: "This's a self made tools testing page" | ||
short_title: "Self made tools testing" | ||
id: doc-testing-page | ||
subtitle: >- | ||
Description\subtitle is now not different than the normal, documentation body markdown texts.<br> | ||
It can contain ', and other special characters ()[].*?+^$, etc., though some of them might require escaping, e.g. \\ or \|<br> | ||
Mentioning documentation sections (markdown ##, or HTML <h 1-6> headings) via the exact section title text should work normally, like | ||
Slack destination options, but the linking can be forced as well via our custom markdown [[[[Timezones and daylight saving]]]] format.<br> | ||
Linking also could work with our {% include markdown_link id='doc-own-tools' title='markdown_link liquid include' withTooltip='yes' %}.<br> | ||
One more [[destination|adm-about-glossary#bom]] id=adm-about-glossary#bom override test from subtutle.<br> | ||
Macros test ${HOST}). | ||
search: false | ||
--- | ||
|
||
## Tests go here | ||
|
||
**INFO:** \{: .notice--info\} Test \ | ||
any modifications or changes, use the **flags(no-parse)** option in the | ||
source definition, and a template containing only the **${MESSAGE}** | ||
macro in the destination definition. | ||
{: .notice--info} | ||
|
||
To parse non-syslog messages, for example, JSON, CSV, or other messages, | ||
you can use the built-in parsers of syslog-ng OSE. For details, see | ||
[[parser: Parse and segment structured messages]]. | ||
|
||
`multi line backticked | ||
text` | ||
|
||
Soft macros (sometimes also called name-value pairs) are either | ||
built-in macros automatically generated from the log message (for | ||
example, ${HOST}), or custom user-created macros generated by using | ||
the syslog-ng pattern database or a CSV-parser. The SDATA fields of | ||
RFC5424-formatted log messages become soft macros as well. In | ||
contrast with hard macros, soft macros are writable and can be | ||
modified within syslog-ng OSE, for example, using rewrite rules. | ||
|
||
**WARNING:** \{: .notice--warning\} Test \ | ||
for the list of hard and soft macros, see [[Hard versus soft macros]]. | ||
{: .notice--warning} | ||
|
||
**DANGER:** \{: .notice--danger\} Test \ | ||
at the location it reaches the log-msg-size() value, and discards the rest of the message. | ||
{: .notice--danger} | ||
|
||
**Code block example:** | ||
|
||
```config | ||
options { | ||
stats( | ||
freq(1) | ||
level(1) | ||
lifetime(1000) | ||
max-dynamics(10000) | ||
syslog-stats(yes) | ||
stats() | ||
); | ||
}; | ||
``` | ||
|
||
--------------------- | ||
|
||
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. | ||
|
||
Developer guide is a double (page title amd section heading) example with a description/subtitle. | ||
|
||
[[Installing syslog-ng|adm-install]] is a forced, (also a doubled) page link title example with a description/subtitle. | ||
|
||
[[Self page link|doc-testing-page]] test. | ||
|
||
The severity of the message. `time-zone()` teszt | ||
|
||
parser: Parse and segment structured messages | ||
|
||
`parser: Parse and segment structured messages` | ||
|
||
discord Sending alerts and notifications to Discord | ||
|
||
`discord Sending alerts and notifications to Discord` | ||
|
||
Timezones and daylight saving | ||
|
||
`Timezones and daylight saving` | ||
|
||
Slack destination options | ||
|
||
[[Slack destination options]] | ||
|
||
`Slack destination options` | ||
|
||
Slack :destination options | ||
|
||
Slack 'destination' options | ||
|
||
`Options of the mqtt() destination` | ||
|
||
[Parse bar] | ||
|
||
Alma [[parser]] korte | ||
|
||
[[destination]] | ||
|
||
[[destination id=bom|adm-about-glossary#bom]] | ||
|
||
[[destination|adm-about-glossary#bom]] id=bom | ||
|
||
[[destination||]] | ||
|
||
[destination|] | ||
|
||
destination| | ||
|
||
[destination] | ||
|
||
<a href="/admin-guide/200_About/002_Glossary#destination" class="nav-link content-tooltip">that is a direct, html link destination test</a> | ||
|
||
[[another destination|adm-about-glossary#destination]] test | ||
|
||
{% include markdown_link id='adm-about-glossary#destination' title='destination apostroph' withTooltip='yes' %} | ||
|
||
{% include markdown_link id="adm-about-glossary#destination" title="destination quote" withTooltip="yes" %} | ||
|
||
message | ||
|
||
[[message]] | ||
|
||
Options is an excluded word. | ||
|
||
For more information, see | ||
[[Options of the kafka() destination's C implementation]]. | ||
|
||
For details, see [[The syslog-ng.conf manual page]]. | ||
|
||
## See also | ||
|
||
[[The syslog-ng.conf manual page]] | ||
|
||
[[The syslog-ng manual page]] | ||
|
||
Here comes an include doc/admin-guide/manpages-footnote.md test | ||
{% include doc/admin-guide/manpages-footnote.md %} | ||
|
||
When encoding is set in a source (using the encoding() option) and the | ||
message is longer (in bytes) than log-msg-size() in UTF-8 | ||
representation, syslog-ng OSE splits the message at an undefined | ||
location (because the conversion between different encodings is not | ||
trivial). | ||
|
||
The following is a simple configuration file for syslog-ng Open | ||
Source Edition that collects incoming log messages and stores them | ||
in a text file. syslog-ng Open Source Edition. | ||
|
||
Aliast testing e.g ${LEVEL} or ${PRIORITY} should work like ${SDATA} |
Oops, something went wrong.