Skip to content

Commit 095c18d

Browse files
authoredMar 18, 2025
Merge branch 'master' into doc-sql-quote
2 parents a94d6ca + bd49690 commit 095c18d

File tree

10 files changed

+82
-4
lines changed

10 files changed

+82
-4
lines changed
 

‎Gemfile

+1
Original file line numberDiff line numberDiff line change
@@ -111,5 +111,6 @@ group :jekyll_plugins do
111111
# https://github.com/HofiOne/minimal-mistakes
112112
#
113113
gem "jekyll-include-cache"
114+
gem "jekyll-github-metadata"
114115
# gem "github-pages"
115116
end

‎_config.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -258,4 +258,4 @@ product:
258258
name: 'syslog-ng Open Source Edition'
259259
short_name: 'syslog-ng OSE'
260260

261-
repository: syslog-ng/syslog-ng
261+
repository: syslog-ng/syslog-ng.github.io

‎_includes/doc/common_snippets

-2
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,6 @@ that contains the include tag, further inherited e.g. layouts will not see the i
1212

1313
{% assign img_folder = '/assets/images' | relative_url %}
1414

15-
{% assign ose_latest = site.github.latest_release.name | remove: '.tar.gz' | remove: 'syslog-ng-' %}
16-
1715
{% include doc/dev-guide/common_snippets %}
1816

1917
{% include doc/admin-guide/common_snippets %}

‎_includes/page__contribution.html

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
{% if site.github.repository_url %}
2+
{% assign contrib_view = site.github.repository_url | append: '/tree/master/' | append: site.collections_dir | append: '/' | append: page.relative_path %}
3+
{% assign contrib_edit = site.github.repository_url | append: '/edit/master/' | append: site.collections_dir | append: '/' | append: page.relative_path %}
4+
{% assign contrib_report = site.github.repository_url | append: '/issues/new?title=Issue with ' | append: page.relative_path %}
5+
6+
<aside class="sidebar__right sticky contrib">
7+
<div class="align-right">
8+
<button id="view" class="masthead_button" type="button" onclick="window.open('{{contrib_view}}', '_blank')">
9+
<i class="masthead_button_icon fas fa-eye content-tooltip tooltip-align-center text-content-tooltip" data-tooltip-text="View page source"></i>
10+
</button>
11+
12+
<button id="edit" class="masthead_button" type="button" onclick="window.open('{{contrib_edit}}', '_blank')">
13+
<i class="masthead_button_icon far fa-edit content-tooltip tooltip-align-center text-content-tooltip" data-tooltip-text="Edit this page"></i>
14+
</button>
15+
16+
<button id="report" class="masthead_button" type="button" onclick="window.open('{{contrib_report}}', '_blank')">
17+
<i class="masthead_button_icon fas fa-bug content-tooltip tooltip-align-center text-content-tooltip" data-tooltip-text="Report an issue"></i>
18+
</button>
19+
</div>
20+
</aside>
21+
{% endif %}

‎_includes/sidebar.html

+2
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@
44
{% assign sidebarItemCount = page.sidebar.nav | size %}
55
{% endif %}
66

7+
{% include page__contribution.html %}
8+
79
<div class="sidebar {% if site.sidebar.sticky == true %}sticky{% endif %} {% if sidebarItemCount == 0 %}empty{% endif %}">
810
{% if page.author_profile or layout.author_profile %}
911
{% include author-profile.html %}

‎_sass/minimal-mistakes/minimal-mistakes/_sidebar.scss

+9
Original file line numberDiff line numberDiff line change
@@ -99,6 +99,14 @@
9999
}
100100
}
101101
}
102+
103+
&.contrib {
104+
top: calc(#{$masthead-sticky} * 2 * #{$nav-height});
105+
margin-bottom: -2em;
106+
padding-right: 2.5em;
107+
width: $right-sidebar-width-wide;
108+
z-index: 0;
109+
}
102110
}
103111

104112
@include breakpoint($x-large) {
@@ -118,6 +126,7 @@
118126
margin-right: 0;
119127
}
120128
}
129+
121130

122131
/*
123132
Author profile and links

‎doc/_admin-guide/070_Destinations/030_Elasticsearch-http/README.md

+12
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,18 @@ HTTPS connection, as well as password- and certificate-based
1313
authentication is supported. The content of the events is sent in JSON
1414
format.
1515

16+
![]({{ site.baseurl}}/assets/images/caution.png) **CAUTION:** When a shard fails to respond to a read request, the coordinating node sends the request to another shard copy in the same replication group. Repeated failures can result in no available shard copies.
17+
{: .notice--warning}
18+
19+
To ensure fast responses, the following APIs will respond with partial results if one or more shards fail:
20+
21+
* Search
22+
* Multi Search
23+
* Bulk
24+
* Multi Get
25+
26+
Responses containing partial results still provide a 200 OK HTTP status code. Shard failures are indicated by the timed_out and _shards fields of the response header.
27+
1628
**Declaration**
1729

1830
```config

‎doc/_admin-guide/070_Destinations/090_http_nonjava/001_http_nonjava_options.md

+34
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,23 @@ The http destination of {{ site.product.short_name }} can directly post log mess
1010
web services using the HTTP protocol. The http destination has the
1111
following options.
1212

13+
## accept-encoding()
14+
15+
| Type:| string|
16+
|Accepted values:| `identity`, `gzip`, `deflate`, `all`|
17+
18+
*Description:* This option requests the compression of HTTP responses from the server. The available values are `gzip`, `deflate`, and `all` to enable all compression types. If no compression is required, use the `identity` value.
19+
20+
### Example: configure an http destination with compression
21+
22+
```config
23+
destination d_http_compressed{
24+
http(url("127.0.0.1:80"),
25+
content-compression("deflate"),
26+
accept-encoding("all"));
27+
};
28+
```
29+
1330
{% include doc/admin-guide/options/batch-bytes.md %}
1431

1532
{% include doc/admin-guide/http-batch.md %}
@@ -59,6 +76,23 @@ version 3.18 and later.
5976

6077
{% include doc/admin-guide/options/cert-file.md %}
6178

79+
## content-compression()
80+
81+
| Type:| string|
82+
|Accepted values:| `identity`, `gzip`, `deflate`, `all`|
83+
84+
*Description:* This option requests {{ site.product.short_name }} to compress sent messages. The available values are `gzip`, `deflate`, and `all` to enable all compression types. If no compression is required, use the `identity` value.
85+
86+
### Example: configure an http destination with compression
87+
88+
```config
89+
destination d_http_compressed{
90+
http(url("127.0.0.1:80"),
91+
content-compression("deflate"),
92+
accept-encoding("all"));
93+
};
94+
```
95+
6296
{% include doc/admin-guide/tls-block.md %}
6397

6498
{% include doc/admin-guide/dedicated-tls-options.md %}

‎doc/_admin-guide/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: syslog-ng Open Source Edition Administration Guides
33
id: adm-guide
44
description: >-
5-
Welcome to the {{ site.product.name }} {{ site.github.latest_release.name | remove: '.tar.gz' | remove: 'syslog-ng-'}} Administration Guide. This document describes how to configure and manage {{ site.product.name }} ({{ site.product.short_name }}). Background information for the technology and concepts used by the product is also discussed.
5+
Welcome to the {{ site.product.name }} 4.8.1 Administration Guide. This document describes how to configure and manage {{ site.product.name }} ({{ site.product.short_name }}). Background information for the technology and concepts used by the product is also discussed.
66
---
77

88
## Target audience

‎doc/_dev-guide/chapter_5/section_7.md

+1
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ guidelines the following:
2020
for syslog-ng. Please try to follow the existing conventions.
2121
4. Always add a `Signed-off-by` tag to the end of **every** commit
2222
message you submit.
23+
Signing off on commits enables users to affirm that a commit complies with the rules and licensing of a repository. This, in the case of {{ site.product.short_name }}, means that you accept our coding and contribution standards described in the Contribution section, and accept that your code will be published with a `GPLv2` license.
2324
5. Always create a separate branch for the pull request, forked off
2425
from the appropriate {{ site.product.short_name }} branch.
2526
6. If your patch should be applied to multiple branches, submit

0 commit comments

Comments
 (0)