Skip to content

Commit

Permalink
Added the first version of the doc tools test playground page (#28)
Browse files Browse the repository at this point in the history
Added some other page link fixes, external link fixes
Signed-off-by: Hofi <[email protected]>
  • Loading branch information
HofiOne authored May 10, 2024
2 parents 8618b95 + 32dc6fb commit 8489a4e
Show file tree
Hide file tree
Showing 8 changed files with 278 additions and 108 deletions.
5 changes: 5 additions & 0 deletions _data/external_links.yml
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,11 @@ sn-blogs:
url: https://syslog-ng.com/blog/
title: [ "syslog-ng blogs" ]

mm-site:
id: mm-site
url: https://mademistakes.com/work/minimal-mistakes-jekyll-theme/
title: [ "Minimal Mistakes" ]

mm-javascripts:
id: mm-javascripts
url: https://mmistakes.github.io/minimal-mistakes/docs/javascript/
Expand Down
6 changes: 5 additions & 1 deletion _data/navigation.yml
Original file line number Diff line number Diff line change
Expand Up @@ -1239,4 +1239,8 @@ doc-guide-nav:
url: /doc-guide/02_Tools/README
subnav:
- title: "Self made helper tools"
url: /doc-guide/02_Tools/01_Our_helpers
url: /doc-guide/02_Tools/01_Self_made_tools/README
subnav:
- title: "Self made tools testing"
url: /doc-guide/02_Tools/01_Self_made_tools/01_Tests/README
subnav:
8 changes: 4 additions & 4 deletions doc/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,23 +9,23 @@ id: doc-center

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

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 %}.
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 %}.

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

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

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.
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.

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

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 %}
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 %}

## If you need help

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

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

Expand Down
8 changes: 4 additions & 4 deletions doc/_dev-guide/chapter_0/section_3.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
---
title: macOS
id: dev-inst-macos
description: >-
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.
---

### Introduction

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.

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]].

If you want to install syslog-ng on macOS you can use multiple packaga managers e.g. Homebrew
Expand Down
98 changes: 0 additions & 98 deletions doc/_doc-guide/02_Tools/01_Our_helpers.md

This file was deleted.

154 changes: 154 additions & 0 deletions doc/_doc-guide/02_Tools/01_Self_made_tools/01_Tests/README.md
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}
Loading

0 comments on commit 8489a4e

Please sign in to comment.