Skip to content

Commit b9862b5

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

Some content is hidden

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

48 files changed

+180
-180
lines changed

doc/_dev-guide/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,12 +15,12 @@ id: dev-guide
1515
The syslog-ng team has started this guide to widen the community of
1616
contributors by providing a short and fair description to the project.
1717
This document was written for users and developers. You can find sections
18-
about installing syslog-ng, others are for introducing you to the tools and techniques we use.
18+
about installing {{ site.product.short_name }}, others are for introducing you to the tools and techniques we use.
1919

2020
We hope that you will find this useful and will be ready to create your own ideas.
2121
Feel free to contribute and propose your chapter ideas.
2222

23-
## The syslog-ng project
23+
## The {{ site.product.short_name }} project
2424

2525
<!-- could not get the badge work with the embedded ref [gh:ose-dev-shell-badge] or (gh:ose-dev-shell-badge) solution -->
2626
[![Build Status](https://github.com/syslog-ng/syslog-ng/actions/workflows/devshell.yml/badge.svg)][gh:ose-monitor]

doc/_dev-guide/chapter_0/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
---
2-
title: Install syslog-ng on different platforms
2+
title: Install {{ site.product.short_name }} on different platforms
33
id: dev-install-syslog-ng
44
---
55

6-
The sections under this chapter give you step-by-step guides to install syslog-ng on different platforms.
6+
The sections under this chapter give you step-by-step guides to install {{ site.product.short_name }} on different platforms.
77
Feel free to write new sections that helps the members of the community to get started with syslog-ng.
88
Installation guides using packages and source are also welcome.
99

doc/_dev-guide/chapter_0/section_1.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,14 +8,14 @@ id: dev-inst-debuan-ubuntu
88

99
## Introduction
1010

11-
This chapter describes how you can install syslog-ng on Debian and on Ubuntu
11+
This chapter describes how you can install {{ site.product.short_name }} on Debian and on Ubuntu
1212
operating systems from our APT repository.
1313

1414
## syslog-ng
1515

16-
## Install syslog-ng from APT repository
16+
## Install {{ site.product.short_name }} from APT repository
1717

18-
The syslog-ng team has an unofficial APT repository hosted by OBS for Debian and Ubuntu.
18+
The {{ site.product.short_name }} team has an unofficial APT repository hosted by OBS for Debian and Ubuntu.
1919
Available versions in the OBS repository :
2020

2121
* 3.6.4
@@ -60,7 +60,7 @@ Repositories are available [here][ref:obs-lbudai-36] and [here][ref:obs-lbudai-3
6060
* syslog-ng-mod-http
6161
* syslog-ng-mod-kafka
6262

63-
### Available modules from syslog-ng Incubator for the 3.6 series
63+
### Available modules from {{ site.product.short_name }} Incubator for the 3.6 series
6464

6565
* syslog-ng-mod-basicfuncs-plus
6666
* syslog-ng-mod-java

doc/_dev-guide/chapter_0/section_2.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,23 +5,23 @@ id: dev-inst-suse
55

66
## Introduction
77

8-
The syslog-ng application has been available in openSUSE and SLES for many years. The included version usually lags behind a version or more. Up to date syslog-ng packages for recent openSUSE and SLES releases are available in the [OBS repositories of Peter Czanik](https://build.opensuse.org/project/subprojects/home:czanik). Depending on the distribution release, syslog-ng, Rsyslog or systemd's journald (package `systemd-logger`) are installed as the default logging solution.
8+
The {{ site.product.short_name }} application has been available in openSUSE and SLES for many years. The included version usually lags behind a version or more. Up to date {{ site.product.short_name }} packages for recent openSUSE and SLES releases are available in the [OBS repositories of Peter Czanik](https://build.opensuse.org/project/subprojects/home:czanik). Depending on the distribution release, {{ site.product.short_name }}, Rsyslog or systemd's journald (package `systemd-logger`) are installed as the default logging solution.
99

1010
None of these packages are officially supported by Balabit, but we try to help resolving problems with our best effort.
1111

12-
## Using the latest syslog-ng version
12+
## Using the latest {{ site.product.short_name }} version
1313

14-
If you want to install the latest available syslog-ng version, add one of the [OBS repositories of Peter Czanik](https://build.opensuse.org/project/subprojects/home:czanik) first. For version 3.6 use the following command:
14+
If you want to install the latest available {{ site.product.short_name }} version, add one of the [OBS repositories of Peter Czanik](https://build.opensuse.org/project/subprojects/home:czanik) first. For version 3.6 use the following command:
1515

1616
```shell
1717
zypper ar http://download.opensuse.org/repositories/home:/czanik:/syslog-ng36/openSUSE_13.2/ syslog-ng36
1818
```
1919

20-
This command line refers to the latest distribution of syslog-ng versions at the time of writing. You might need to change either one or both version numbers. You can skip this step, if you do not need the latest syslog-ng version.
20+
This command line refers to the latest distribution of {{ site.product.short_name }} versions at the time of writing. You might need to change either one or both version numbers. You can skip this step, if you do not need the latest {{ site.product.short_name }} version.
2121

2222
## Checking available subpackages
2323

24-
The syslog-ng package on openSUSE is organized into a core package called `syslog-ng` and sub packages with extra dependencies. You can search for a full list of packages using `zypper`:
24+
The {{ site.product.short_name }} package on openSUSE is organized into a core package called `syslog-ng` and sub packages with extra dependencies. You can search for a full list of packages using `zypper`:
2525

2626
```shell
2727
linux-uv4b:~ # zypper se syslog-ng

doc/_dev-guide/chapter_0/section_3.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,14 @@
22
title: macOS
33
id: dev-inst-macos
44
description: >-
5-
The syslog-ng application has been resurrected on macOS by our developer team.
5+
The {{ site.product.short_name }} application has been resurrected on macOS by our developer team.
66
We hope our product can be useful for Mac users who want to increase the
77
security of their system through reliable logging.
88
---
99

10-
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]].
10+
At present we are not supporting macOS {{ site.product.short_name }} on our [[official repository|gh-syslog-ng]] on GitHub. However, you can install pre-built {{ site.product.short_name }} binaries from various sources or can compile yourself following [[this guide|dev-platform-build-macos#compiling-from-source]].
1111

12-
If you want to install syslog-ng on macOS you can use multiple packaga managers e.g. Homebrew
12+
If you want to install {{ site.product.short_name }} on macOS you can use multiple packaga managers e.g. Homebrew
1313

1414
### Homebrew
1515

@@ -22,15 +22,15 @@ Homebrew has now different home directories on ARM and X86 systems, also the loc
2222

2323
### Checking dependencies
2424

25-
The syslog-ng package on macOS in homebrew is organized into a formula called `syslog-ng`.
25+
The {{ site.product.short_name }} package on macOS in homebrew is organized into a formula called `syslog-ng`.
2626

2727
For checking [[dependencies|dev-platform-build-macos#dependencies]] of it you can use
2828

2929
```shell
3030
brew deps syslog-ng
3131
```
3232

33-
This will list all the required dependencies are needed to run syslog-ng, and homebrew would install automatically as needed.
33+
This will list all the required dependencies are needed to run {{ site.product.short_name }}, and homebrew would install automatically as needed.
3434

3535
### Installation
3636

@@ -40,7 +40,7 @@ Using homebrew it is simple, use
4040
brew install syslog-ng
4141
```
4242

43-
This command line refers to the latest distribution of syslog-ng versions at the time of writing, and usually updated quickly by the homwbrew crew after a new release.
43+
This command line refers to the latest distribution of {{ site.product.short_name }} versions at the time of writing, and usually updated quickly by the homwbrew crew after a new release.
4444

4545
### Starting syslog-ng
4646

@@ -58,17 +58,17 @@ To see more details you can specify some debug flags, like
5858
${HOMEBREW_PREFIX}/sbin/syslog-ng -Fdevt
5959
```
6060

61-
this will give you detailed information of what syslog-ng does.
61+
this will give you detailed information of what {{ site.product.short_name }} does.
6262

63-
### Running syslog-ng as daemon
63+
### Running {{ site.product.short_name }} as daemon
6464

6565
You can start it manually as a backround daemon
6666

6767
```shell
6868
${HOMEBREW_PREFIX}/sbin/syslog-ng
6969
```
7070

71-
however this is not a persistent state, after a system restart syslog-ng will not start automatically by default.
71+
however this is not a persistent state, after a system restart {{ site.product.short_name }} will not start automatically by default.
7272

7373
To run it as a daemon that will automatically start at system startup and is kept alive you can use `launchd`
7474

doc/_dev-guide/chapter_0/section_4.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,11 @@ id: dev-inst-freebsd
55

66
## Introduction
77

8-
The syslog-ng application has been available in FreeBSD ports for many years. Recently, thanks to the hard work of the FreeBSD team, syslog-ng is also available as a ready-to-install package.
8+
The {{ site.product.short_name }} application has been available in FreeBSD ports for many years. Recently, thanks to the hard work of the FreeBSD team, {{ site.product.short_name }} is also available as a ready-to-install package.
99

10-
The default configuration for `syslog-ng` in ports contains only the most important dependencies. If you use a package, this is how your package is configured. This covers the needs of most syslog-ng users. If you need a specific feature not available with the default configuration in ports, you need to compile syslog-ng yourself.
10+
The default configuration for `syslog-ng` in ports contains only the most important dependencies. If you use a package, this is how your package is configured. This covers the needs of most {{ site.product.short_name }} users. If you need a specific feature not available with the default configuration in ports, you need to compile {{ site.product.short_name }} yourself.
1111

12-
The following list shows the available syslog-ng and related ports in FreeBSD, by the time of writing this chapter:
12+
The following list shows the available {{ site.product.short_name }} and related ports in FreeBSD, by the time of writing this chapter:
1313

1414
* syslog-ng: the latest stable version (not necesseraly a .1 :-) )
1515
* syslog-ng-devel: the latest development version (alpha/beta and usually .1 too...)
@@ -25,7 +25,7 @@ You can view the current list of available ports by looking into `/usr/ports/sys
2525

2626
None of these packages are officially supported by Balabit, but we try to help resolving problems with our best effort.
2727

28-
## Installing syslog-ng from package
28+
## Installing {{ site.product.short_name }} from package
2929

3030
The following command will install `syslog-ng` and all necessary dependencies:
3131

@@ -35,7 +35,7 @@ pkg install syslog-ng
3535

3636
_Note:_ Installation does not start `syslog-ng` or enables it to start automagically.
3737

38-
## Compiling syslog-ng from ports
38+
## Compiling {{ site.product.short_name }} from ports
3939

4040
These are the minimal steps to compile `syslog-ng` from ports with features and dependencies you need.
4141

@@ -86,7 +86,7 @@ May 19 11:57:18 fb101r root: this is a test
8686
root@fb101r:/usr/ports/sysutils/syslog-ng #
8787
```
8888

89-
## Enable syslog-ng to start by default
89+
## Enable {{ site.product.short_name }} to start by default
9090

9191
Enable `syslog-ng` to start by default with the following two lines appended to `/etc/rc.conf`:
9292

@@ -97,4 +97,4 @@ syslog_ng_enable="YES
9797
9898
_Note:_ for more information read the [run first](https://github.com/syslog-ng/doc/blob/develop/pages/dev-guide/chapter_\_0/chapters/chapter\_2/README.md) guide.
9999
100-
_Note:_ for more information read the syslog-ng [documentation](http://www.balabit.com/sites/default/files/documents/syslog-ng-ose-latest-guides/en/syslog-ng-ose-guide-admin/html-single/index.html)
100+
_Note:_ for more information read the {{ site.product.short_name }} [documentation](http://www.balabit.com/sites/default/files/documents/syslog-ng-ose-latest-guides/en/syslog-ng-ose-guide-admin/html-single/index.html)

doc/_dev-guide/chapter_1/section_1.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ id: dev-struct-proj
66
The following directories are the most substantial ones:
77

88
* `lib/`: common source code used by syslog-ng
9-
* `modules/`: each module in syslog-ng has a directory here, like `redis`
9+
* `modules/`: each module in {{ site.product.short_name }} has a directory here, like `redis`
1010
* `syslog-ng`: the source code of the `syslog-ng` binary
1111
* `syslog-ng-ctl`: the source code of the `syslog-ng-ctl` command line utility
1212
* `tests`: the home of unit tests and functional tests (but there are tests next to their tested functionality)

doc/_dev-guide/chapter_2/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,5 +5,5 @@ id: dev-compile-first
55

66
This chapter describes the building and testing process of syslog-ng.
77

8-
If you want to develop syslog-ng, you should be familiar with building syslog-ng
8+
If you want to develop {{ site.product.short_name }}, you should be familiar with building syslog-ng
99
from source.

doc/_dev-guide/chapter_2/section_1.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ id: dev-comp-deps
2020
[gh:criterion]: http://github.com/Snaipe/Criterion
2121
[ref:libxml2]: http://www.xmlsoft.org/
2222

23-
Like every project, syslog-ng also uses other libraries and projects.
23+
Like every project, {{ site.product.short_name }} also uses other libraries and projects.
2424
That is why these dependencies must be fetched before compiling.
2525
In this section we list these libraries and version restrictions.
2626

doc/_dev-guide/chapter_2/section_2/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ This script will clone the Git submodules and initialize the build system. The
2424
result of the execution should be a `configure` script.
2525

2626
1. Create build directory
27-
We prefer to build syslog-ng in a dedicated directory, so your Git repo is kept
27+
We prefer to build {{ site.product.short_name }} in a dedicated directory, so your Git repo is kept
2828
tidy.
2929

3030
``` shell
@@ -56,7 +56,7 @@ but `make -j` does not, that is a bug.
5656

5757
### Expected outcome
5858

59-
You should have a freshly built syslog-ng by the end of this step.
59+
You should have a freshly built {{ site.product.short_name }} by the end of this step.
6060

6161
## Cleanup
6262

0 commit comments

Comments
 (0)