Skip to content

Commit 8489a4e

Browse files
HofiOneHofiOne
authored
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]>
2 parents 8618b95 + 32dc6fb commit 8489a4e

File tree

8 files changed

+278
-108
lines changed

8 files changed

+278
-108
lines changed

‎_data/external_links.yml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,11 @@ sn-blogs:
6363
url: https://syslog-ng.com/blog/
6464
title: [ "syslog-ng blogs" ]
6565

66+
mm-site:
67+
id: mm-site
68+
url: https://mademistakes.com/work/minimal-mistakes-jekyll-theme/
69+
title: [ "Minimal Mistakes" ]
70+
6671
mm-javascripts:
6772
id: mm-javascripts
6873
url: https://mmistakes.github.io/minimal-mistakes/docs/javascript/

‎_data/navigation.yml

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1239,4 +1239,8 @@ doc-guide-nav:
12391239
url: /doc-guide/02_Tools/README
12401240
subnav:
12411241
- title: "Self made helper tools"
1242-
url: /doc-guide/02_Tools/01_Our_helpers
1242+
url: /doc-guide/02_Tools/01_Self_made_tools/README
1243+
subnav:
1244+
- title: "Self made tools testing"
1245+
url: /doc-guide/02_Tools/01_Self_made_tools/01_Tests/README
1246+
subnav:

‎doc/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,23 +9,23 @@ id: doc-center
99

1010
## {% include markdown_link id="doc-guide" title="Documentation guide" outOfFrame=true %}
1111

12-
If you would like to help us to make our documentation better, here you can find information about {% include markdown_link id="doc-guide#how-to-contribute-to-the-documentation" title="how to contribute" outOfFrame=true %}.
12+
If you would like to help us to make our documentation better, here you can find information about {% include markdown_link id="doc-guide#how-to-contribute-to-the-documentation" title="how to contribute" outOfFrame=true withTooltip=true %}.
1313

1414
[![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)
1515

1616
## {% include markdown_link id="adm-guide" title="Administration guide" outOfFrame=true %}
1717

18-
If you are an active user of syslog-ng, start here to {% include markdown_link id="adm-guide" title="learn" outOfFrame=true %} about installation, configuration, and fine tuning syslog-ng.
18+
If you are an active user of syslog-ng, start here to {% include markdown_link id="adm-guide" title="learn" outOfFrame=true withTooltip=true %} about installation, configuration, and fine tuning syslog-ng.
1919

2020
## {% include markdown_link id="dev-guide" title="Developer guide" outOfFrame=true %}
2121

22-
Want to add your idea, bug-fix to the fabolous syslog-ng? Take a look at our {% include markdown_link id="dev-guide" title="developer guide" outOfFrame=true %}
22+
Want to add your idea, bug-fix to the fabolous syslog-ng? Take a look at our {% include markdown_link id="dev-guide" title="developer guide" outOfFrame=true withTooltip=true %}
2323

2424
## If you need help
2525

2626
In case you have any question, comment, or feedback, you can:
2727

28-
* first check out our {% include markdown_link id="doc-guide#how-to-contribute-to-the-documentation" title="contribution guide" outOfFrame=true %}
28+
* first check out our {% include markdown_link id="doc-guide#how-to-contribute-to-the-documentation" title="contribution guide" outOfFrame=true withTooltip=true %}
2929
* post your question on the syslog-ng mailing list
3030
* use our github to track all of the [[documentation issues|gh-syslog-ng-doc-issue-tracker]]
3131

‎doc/_dev-guide/chapter_0/section_3.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
---
22
title: macOS
33
id: dev-inst-macos
4+
description: >-
5+
The syslog-ng application has been resurrected on macOS by our developer team.
6+
We hope our product can be useful for Mac users who want to increase the
7+
security of their system through reliable logging.
48
---
59

6-
### Introduction
7-
8-
The syslog-ng application has been resurrected on macOS by our developer team. We hope our product can be useful for Mac users who want to increase the security of their system through reliable logging.
9-
1010
At present we are not supporting macOS syslog-ng on our [[official repository|gh-syslog-ng]] on GitHub. However, you can install pre-built syslog-ng binaries from various sources or can compile yourself following [[this guide|dev-platform-build-macos#compiling-from-source]].
1111

1212
If you want to install syslog-ng on macOS you can use multiple packaga managers e.g. Homebrew

‎doc/_doc-guide/02_Tools/01_Our_helpers.md

Lines changed: 0 additions & 98 deletions
This file was deleted.

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

Lines changed: 154 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,154 @@
1+
---
2+
title: "This's a self made tools testing page"
3+
short_title: "Self made tools testing"
4+
id: doc-testing-page
5+
subtitle: >-
6+
Description\subtitle is now not different than the normal, documentation body markdown texts.<br>
7+
It can contain ', and other special characters ()[].*?+^$, etc., though some of them might require escaping, e.g. \\ or \|<br>
8+
Mentioning documentation sections (markdown ##, or HTML <h 1-6> headings) via the exact section title text should work normally, like
9+
Slack destination options, but the linking can be forced as well via our custom markdown [[[[Timezones and daylight saving]]]] format.<br>
10+
Linking also could work with our {% include markdown_link id='doc-own-tools' title='markdown_link liquid include' withTooltip='yes' %}.<br>
11+
One more [[destination|adm-about-glossary#bom]] id=adm-about-glossary#bom override test from subtutle.<br>
12+
Macros test ${HOST}).
13+
search: false
14+
---
15+
16+
## Tests go here
17+
18+
**INFO:** \{: .notice--info\} Test \
19+
any modifications or changes, use the **flags(no-parse)** option in the
20+
source definition, and a template containing only the **${MESSAGE}**
21+
macro in the destination definition.
22+
{: .notice--info}
23+
24+
To parse non-syslog messages, for example, JSON, CSV, or other messages,
25+
you can use the built-in parsers of syslog-ng OSE. For details, see
26+
[[parser: Parse and segment structured messages]].
27+
28+
`multi line backticked
29+
text`
30+
31+
Soft macros (sometimes also called name-value pairs) are either
32+
built-in macros automatically generated from the log message (for
33+
example, ${HOST}), or custom user-created macros generated by using
34+
the syslog-ng pattern database or a CSV-parser. The SDATA fields of
35+
RFC5424-formatted log messages become soft macros as well. In
36+
contrast with hard macros, soft macros are writable and can be
37+
modified within syslog-ng OSE, for example, using rewrite rules.
38+
39+
**WARNING:** \{: .notice--warning\} Test \
40+
for the list of hard and soft macros, see [[Hard versus soft macros]].
41+
{: .notice--warning}
42+
43+
**DANGER:** \{: .notice--danger\} Test \
44+
at the location it reaches the log-msg-size() value, and discards the rest of the message.
45+
{: .notice--danger}
46+
47+
**Code block example:**
48+
49+
```config
50+
options {
51+
stats(
52+
freq(1)
53+
level(1)
54+
lifetime(1000)
55+
max-dynamics(10000)
56+
syslog-stats(yes)
57+
stats()
58+
);
59+
};
60+
```
61+
62+
---------------------
63+
64+
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.
65+
66+
Developer guide is a double (page title amd section heading) example with a description/subtitle.
67+
68+
[[Installing syslog-ng|adm-install]] is a forced, (also a doubled) page link title example with a description/subtitle.
69+
70+
[[Self page link|doc-testing-page]] test.
71+
72+
The severity of the message. `time-zone()` teszt
73+
74+
parser: Parse and segment structured messages
75+
76+
`parser: Parse and segment structured messages`
77+
78+
discord Sending alerts and notifications to Discord
79+
80+
`discord Sending alerts and notifications to Discord`
81+
82+
Timezones and daylight saving
83+
84+
`Timezones and daylight saving`
85+
86+
Slack destination options
87+
88+
[[Slack destination options]]
89+
90+
`Slack destination options`
91+
92+
Slack :destination options
93+
94+
Slack 'destination' options
95+
96+
`Options of the mqtt() destination`
97+
98+
[Parse bar]
99+
100+
Alma [[parser]] korte
101+
102+
[[destination]]
103+
104+
[[destination id=bom|adm-about-glossary#bom]]
105+
106+
[[destination|adm-about-glossary#bom]] id=bom
107+
108+
[[destination||]]
109+
110+
[destination|]
111+
112+
destination|
113+
114+
[destination]
115+
116+
<a href="/admin-guide/200_About/002_Glossary#destination" class="nav-link content-tooltip">that is a direct, html link destination test</a>
117+
118+
[[another destination|adm-about-glossary#destination]] test
119+
120+
{% include markdown_link id='adm-about-glossary#destination' title='destination apostroph' withTooltip='yes' %}
121+
122+
{% include markdown_link id="adm-about-glossary#destination" title="destination quote" withTooltip="yes" %}
123+
124+
message
125+
126+
[[message]]
127+
128+
Options is an excluded word.
129+
130+
For more information, see
131+
[[Options of the kafka() destination's C implementation]].
132+
133+
For details, see [[The syslog-ng.conf manual page]].
134+
135+
## See also
136+
137+
[[The syslog-ng.conf manual page]]
138+
139+
[[The syslog-ng manual page]]
140+
141+
Here comes an include doc/admin-guide/manpages-footnote.md test
142+
{% include doc/admin-guide/manpages-footnote.md %}
143+
144+
When encoding is set in a source (using the encoding() option) and the
145+
message is longer (in bytes) than log-msg-size() in UTF-8
146+
representation, syslog-ng OSE splits the message at an undefined
147+
location (because the conversion between different encodings is not
148+
trivial).
149+
150+
The following is a simple configuration file for syslog-ng Open
151+
Source Edition that collects incoming log messages and stores them
152+
in a text file. syslog-ng Open Source Edition.
153+
154+
Aliast testing e.g ${LEVEL} or ${PRIORITY} should work like ${SDATA}

0 commit comments

Comments
 (0)