Skip to content

Commit 6f05498

Browse files
mrgarris0nmrgarris0n
authored
Description uplift (#92)
Added some (actually a lot of) missing descriptions to documentation pages. Fixes: #25
2 parents f9015ef + 089f446 commit 6f05498

File tree

200 files changed

+538
-302
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

200 files changed

+538
-302
lines changed

‎_data/navigation.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -836,13 +836,13 @@ admin-guide-nav:
836836
url: /admin-guide/120_Parser/014_panos_parser/001_Panos_parser_options
837837
- title: "Sudo parser"
838838
url: /admin-guide/120_Parser/015_sudo_parser
839+
- title: "MariaDB parser"
840+
url: /admin-guide/120_Parser/016_mariadb_parser
839841
- title: "PostgreSQL parser"
840842
url: /admin-guide/120_Parser/016_PostgreSQL_csvlog_parser/README
841843
subnav:
842844
- title: "PostgreSQL csvlog parser options"
843845
url: /admin-guide/120_Parser/016_PostgreSQL_csvlog_parser/001_PostgreSQL_parser_options
844-
- title: "MariaDB parser"
845-
url: /admin-guide/120_Parser/016_mariadb_parser
846846
- title: "metrics-probe()"
847847
url: /admin-guide/120_Parser/017_metrics_probe_parser/README
848848
subnav:

‎doc/_admin-guide/010_Introduction_to_syslog-ng/001_What_syslog-ng_is_not.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
---
22
title: What {{ site.product.short_name }} is not
33
id: adm-intro-whatnot
4+
description: >-
5+
The {{ site.product.short_name }} application is not log analysis software. It can filter
6+
log messages and select only the ones matching certain criteria. It can
7+
even convert the messages and restructure them to a predefined format,
8+
or parse the messages and segment them into different fields. But
9+
{{ site.product.short_name }} cannot interpret and analyze the meaning behind the messages,
10+
or recognize patterns in the occurrence of different messages.
411
---
5-
6-
The {{ site.product.short_name }} application is not log analysis software. It can filter
7-
log messages and select only the ones matching certain criteria. It can
8-
even convert the messages and restructure them to a predefined format,
9-
or parse the messages and segment them into different fields. But
10-
{{ site.product.short_name }} cannot interpret and analyze the meaning behind the messages,
11-
or recognize patterns in the occurrence of different messages.

‎doc/_admin-guide/010_Introduction_to_syslog-ng/003_Who_uses_syslog-ng.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,13 @@
11
---
22
title: Who uses {{ site.product.short_name }}?
33
id: adm-intro-who
4+
description: >-
5+
The {{ site.product.short_name }} application is used worldwide by companies and
6+
institutions who collect and manage the logs of several hosts, and want
7+
to store them in a centralized, organized way.
48
---
59

6-
The {{ site.product.short_name }} application is used worldwide by companies and
7-
institutions who collect and manage the logs of several hosts, and want
8-
to store them in a centralized, organized way. Using {{ site.product.short_name }} is
9-
particularly advantageous for:
10+
Using {{ site.product.short_name }} is particularly advantageous for:
1011

1112
- Internet Service Providers
1213

‎doc/_admin-guide/010_Introduction_to_syslog-ng/004_Supported_platforms.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
---
22
title: Supported platforms
33
id: adm-intro-supp
4+
description: >-
5+
The {{ site.product.short_name }} application is highly
6+
portable and is known to run on a wide range of hardware architectures
7+
(x86, x86_64, SUN Sparc, PowerPC 32 and 64, Alpha, ARM64) and operating
8+
systems, including Linux, BSD, Solaris, IBM AIX, HP-UX, macOS,
9+
Cygwin, and others.
410
---
511

6-
The {{ site.product.short_name }} application is highly
7-
portable and is known to run on a wide range of hardware architectures
8-
(x86, x86_64, SUN Sparc, PowerPC 32 and 64, Alpha, ARM64) and operating
9-
systems, including Linux, BSD, Solaris, IBM AIX, HP-UX, macOS,
10-
Cygwin, and others.
11-
1212
- The [[source code|gh-syslog-ng]] of {{ site.product.name }} is released under the GPLv2 license
1313

1414
- For the available binary installation packages, see {{ site.product.name }} installation packages.

‎doc/_admin-guide/010_Introduction_to_syslog-ng/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
---
22
title: Introduction to syslog-ng
33
id: adm-intro
4+
description: >-
5+
This chapter introduces the {{ site.product.name }} application in
6+
a non-technical manner, discussing how and why is it useful, and the
7+
benefits it offers to an existing IT infrastructure.
48
---
5-
6-
This chapter introduces the {{ site.product.name }} application in
7-
a non-technical manner, discussing how and why is it useful, and the
8-
benefits it offers to an existing IT infrastructure.

‎doc/_admin-guide/020_The_concepts_of_syslog-ng/003_Global_objects.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
---
22
title: Global objects
33
id: adm-conc-glob
4+
description: >-
5+
This section explains some basic terminology used in {{ site.product.short_name }}.
46
---
57

68
## Source driver

‎doc/_admin-guide/030_Installing_syslog-ng/001_Compiling_options.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
---
22
title: Compiling options of {{ site.product.short_name }}
33
id: adm-inst-compopt
4+
description: >-
5+
This chapter describes the compiling options of {{ site.product.short_name }}.
46
---
57

68
When compiling {{ site.product.short_name }} from source, you can use the following

‎doc/_admin-guide/030_Installing_syslog-ng/002_Uninstalling_syslog-ng.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
---
22
title: Uninstalling {{ site.product.short_name }}
33
id: adm-inst-uninst
4+
description: >-
5+
This chapter gives you instructions about the uninstallation of {{ site.product.short_name }}.
46
---
57

68
If you need to uninstall {{ site.product.short_name }} for some reason, you have the

‎doc/_admin-guide/030_Installing_syslog-ng/003_Configuring_MSSQL_server.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,16 @@
11
---
2-
title: Configuring Microsoft SQL Server to accept logs from syslog-ng
2+
title: Configuring Microsoft SQL Server to accept logs from {{ site.product.short_name }}
33
short_title: Configuring MSSQL Server
44
id: adm-inst-mssql
5+
description: >-
6+
This chapter explains how to configure an MSSQL Server to work with {{ site.product.short_name }}.
57
---
68

79
{% assign crumb = page.url | split: '/' %}
810
{% assign img_folder = crumb[-2] | prepend: '/assets/images/admin-guide/'%}
911

1012
Complete the following steps to configure your Microsoft SQL Server to
11-
enable remote logins and accept log messages from syslog-ng.
13+
enable remote logins and accept log messages from {{ site.product.short_name }}.
1214

1315
1. Start the SQL Server Management Studio application. Select
1416
**Start \> Programs \> Microsoft SQL Server 2005 \> SQL Server

‎doc/_admin-guide/040_Quick-start_guide/000_Configuring_syslog-ng_on_client_hosts.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,11 @@
22
title: Configuring {{ site.product.short_name }} on client hosts
33
id: adm-qs-client-conf
44
description: >-
5-
To configure {{ site.product.short_name }} on a client host, complete the following steps.
5+
This section explains how to configure {{ site.product.short_name }} on a client host.
66
---
77

8+
To configure {{ site.product.short_name }} on a client host, complete the following steps.
9+
810
## Steps
911

1012
1. Install the {{ site.product.short_name }} application on the host. For details

0 commit comments

Comments
 (0)