From 5ad7aff083f7dbf848b3834b16b70c431674ae4d Mon Sep 17 00:00:00 2001 From: Shizuo Fujita Date: Wed, 7 Oct 2026 13:48:25 +0900 Subject: [PATCH] Fix heading anchors broken by the HonKit migration HonKit builds heading ids with different rules from GitBook. It drops "_", "<", ">" and "/", and does not add the "id-" prefix. 26 links still used the GitBook ids, so they did not jump to the heading. Update them to the ids in the generated HTML. Co-Authored-By: Claude Opus 5.5 Signed-off-by: Shizuo Fujita --- buffer/file.md | 4 ++-- buffer/file_single.md | 4 ++-- configuration/config-file.md | 2 +- deployment/logging.md | 2 +- deployment/source-only-mode.md | 4 ++-- deployment/system-config.md | 10 +++++----- deployment/zero-downtime-restart.md | 2 +- formatter/json.md | 2 +- input/forward.md | 4 ++-- input/http.md | 2 +- input/syslog.md | 2 +- input/tail.md | 2 +- output/forward.md | 2 +- parser/README.md | 2 +- parser/multiline.md | 2 +- plugin-helper-overview/api-plugin-helper-server.md | 4 ++-- 16 files changed, 25 insertions(+), 25 deletions(-) diff --git a/buffer/file.md b/buffer/file.md index 59e915e2..72da9894 100644 --- a/buffer/file.md +++ b/buffer/file.md @@ -135,7 +135,7 @@ The permission of the buffer chunk files, in the octal format. The same permissi ``` -If this parameter is not set, [`file_permission`](../deployment/system-config.md#file_permission) in the [system configuration](../deployment/system-config.md) is used. If it is not set either, `0644` is used. +If this parameter is not set, [`file_permission`](../deployment/system-config.md#filepermission) in the [system configuration](../deployment/system-config.md) is used. If it is not set either, `0644` is used. ### `dir_permission` @@ -156,7 +156,7 @@ The permission of the directory created to store the buffer chunk files, in the ``` -If this parameter is not set, [`dir_permission`](../deployment/system-config.md#dir_permission) in the [system configuration](../deployment/system-config.md) is used. If it is not set either, `0755` is used. +If this parameter is not set, [`dir_permission`](../deployment/system-config.md#dirpermission) in the [system configuration](../deployment/system-config.md) is used. If it is not set either, `0755` is used. ## Tips diff --git a/buffer/file_single.md b/buffer/file_single.md index a387a3a7..aa40cdaf 100644 --- a/buffer/file_single.md +++ b/buffer/file_single.md @@ -105,7 +105,7 @@ The permission of the buffer chunk files, in the octal format. ``` -If this parameter is not set, [`file_permission`](../deployment/system-config.md#file_permission) in the [system configuration](../deployment/system-config.md) is used. If it is not set either, `0644` is used. +If this parameter is not set, [`file_permission`](../deployment/system-config.md#filepermission) in the [system configuration](../deployment/system-config.md) is used. If it is not set either, `0644` is used. ### `dir_permission` @@ -127,7 +127,7 @@ The permission of the directory created to store the buffer chunk files, in the ``` -If this parameter is not set, [`dir_permission`](../deployment/system-config.md#dir_permission) in the [system configuration](../deployment/system-config.md) is used. If it is not set either, `0755` is used. +If this parameter is not set, [`dir_permission`](../deployment/system-config.md#dirpermission) in the [system configuration](../deployment/system-config.md) is used. If it is not set either, `0755` is used. ## Limitation diff --git a/configuration/config-file.md b/configuration/config-file.md index 0054eea0..1e394305 100644 --- a/configuration/config-file.md +++ b/configuration/config-file.md @@ -581,7 +581,7 @@ These parameters are reserved and are prefixed with an `@` symbol: * `@label`: specifies the label symbol. See - [label](config-file.md#id-5.-group-filter-and-output-the-label-directive) + [label](config-file.md#5-group-filter-and-output-the-label-directive) section. diff --git a/deployment/logging.md b/deployment/logging.md index e485e462..7b7a1c39 100644 --- a/deployment/logging.md +++ b/deployment/logging.md @@ -183,7 +183,7 @@ It can be configured through `` directive under ``: ``` -You need to specify [`rotate_age`](system-config.md#rotate_age) or [`rotate_size`](system-config.md#rotate_size) options explicitly to enable log rotation. +You need to specify [`rotate_age`](system-config.md#rotateage) or [`rotate_size`](system-config.md#rotatesize) options explicitly to enable log rotation. NOTE: You can omit one of these 2 options to use the default value, but if you omit both of them, log rotation is disabled. Actually, an external library manages these default values, resulting in this complication. diff --git a/deployment/source-only-mode.md b/deployment/source-only-mode.md index 79fc1cb7..dec199e2 100644 --- a/deployment/source-only-mode.md +++ b/deployment/source-only-mode.md @@ -13,7 +13,7 @@ Since v1.18.0, Fluentd can launch with source-only mode. You can launch Fluentd with source-only mode in the following ways. * [Command Line Option - --with-source-only](command-line-option.md) -* [System Configuration - with_source_only](system-config.md#with_source_only) +* [System Configuration - with_source_only](system-config.md#withsourceonly) ## Temporary file buffer @@ -41,7 +41,7 @@ It works with the default settings of `out_buffer` except for the following poin If needed, you can configure some options for the buffer in System Configuration. Please see the following for details. -* [System Configuration - source_only_buffer section](system-config.md#less-than-source_only_buffer-greater-than-section). +* [System Configuration - source_only_buffer section](system-config.md#sourceonlybuffer-section). ### Recovery diff --git a/deployment/system-config.md b/deployment/system-config.md index 8d51a0b5..51f27996 100644 --- a/deployment/system-config.md +++ b/deployment/system-config.md @@ -64,7 +64,7 @@ Specifies the time value of the emitting of error log interval. Specify interval to ignore repeated log/stacktrace messages. -See also [Logging article](logging.md#ignore_repeated_log_interval). +See also [Logging article](logging.md#ignorerepeatedloginterval). ### `ignore_same_log_interval` @@ -74,7 +74,7 @@ See also [Logging article](logging.md#ignore_repeated_log_interval). Specify interval to ignore same log/stacktrace messages. -See also [Logging article](logging.md#ignore_same_log_interval). +See also [Logging article](logging.md#ignoresameloginterval). ### `suppress_config_dump` @@ -312,7 +312,7 @@ The temporary buffer setting for [Source Only Mode](source-only-mode.md). | :--- | :--- | :--- | | integer | 1 | 1.18.0 | -See [Output Plugins - flush_thread_count](../output#flush_thread_count) for details. +See [Output Plugins - flush_thread_count](../output#flushthreadcount) for details. #### `overflow_action` @@ -320,7 +320,7 @@ See [Output Plugins - flush_thread_count](../output#flush_thread_count) for deta | :--- | :--- | :--- | | enum | drop_oldest_chunk | 1.18.0 | -See [Output Plugins - overflow_action](../output#overflow_action) for details. +See [Output Plugins - overflow_action](../output#overflowaction) for details. #### `path` @@ -338,7 +338,7 @@ See [Buffer Plugins - file - path](../buffer/file.md#path) for details. | :--- | :--- | :--- | | integer | 10 | 1.18.0 | -See [Output Plugins - flush_interval](../output#flush_interval) for details. +See [Output Plugins - flush_interval](../output#flushinterval) for details. #### `chunk_limit_size` diff --git a/deployment/zero-downtime-restart.md b/deployment/zero-downtime-restart.md index 3ddb065a..553119d3 100644 --- a/deployment/zero-downtime-restart.md +++ b/deployment/zero-downtime-restart.md @@ -40,4 +40,4 @@ You can use this feature in the following ways. ## Plugins: how to support this feature -See [How to Write Input Plugin - zero_downtime_restart_ready?](../plugin-development/api-plugin-input.md#zero_downtime_restart_ready). +See [How to Write Input Plugin - zero_downtime_restart_ready?](../plugin-development/api-plugin-input.md#zerodowntimerestartready). diff --git a/formatter/json.md b/formatter/json.md index 15f570dd..5fac91b9 100644 --- a/formatter/json.md +++ b/formatter/json.md @@ -19,7 +19,7 @@ Sets the library used to generate JSON. Despite its name, this parameter is for If `oj` is specified, the [`oj`](https://github.com/ohler55/oj) gem is used. The gem must be installed separately because Fluentd does not require it by default. If it is not installed, the `json` standard library is used as a fallback and it is reported in the log at the info level. -Any other value, including `yajl`, selects the `json` standard library. Unlike [`json_parser`](../parser/json.md#json_parser) of the `json` parser plugin, this parameter is not restricted to a fixed list of values. +Any other value, including `yajl`, selects the `json` standard library. Unlike [`json_parser`](../parser/json.md#jsonparser) of the `json` parser plugin, this parameter is not restricted to a fixed list of values. ### `add_newline` diff --git a/input/forward.md b/input/forward.md index 9db880a8..fb063bea 100644 --- a/input/forward.md +++ b/input/forward.md @@ -120,7 +120,7 @@ The connections will be disconnected right after receiving a message, if `true`. | :--- | :--- | :--- | | bool | false | 1.4.2 | -Enables the TCP keepalive for sockets. See [socket article](../plugin-helper-overview/api-plugin-helper-socket.md#send_keepalive_packet-use-case) for more details. +Enables the TCP keepalive for sockets. See [socket article](../plugin-helper-overview/api-plugin-helper-socket.md#sendkeepalivepacket-use-case) for more details. ### `chunk_size_limit` @@ -421,7 +421,7 @@ $ echo -e '\x93\xa9debug.tls\xceZr\xbc1\x81\xa3foo\xa3bar' | \ openssl s_client -connect localhost:24224 ``` -If you can confirm TLS encryption has been set up correctly, please proceed to the configuration of the [`out_forward`](../output/forward.md#how-to-connect-to-a-tls-ssl-enabled-server) server. +If you can confirm TLS encryption has been set up correctly, please proceed to the configuration of the [`out_forward`](../output/forward.md#how-to-connect-to-a-tlsssl-enabled-server) server. ### How to Enable TLS Mutual Authentication diff --git a/input/http.md b/input/http.md index 5d31ba47..af8d8f61 100644 --- a/input/http.md +++ b/input/http.md @@ -448,7 +448,7 @@ curl -X POST -d "$msgpack" -H 'Content-Type: application/msgpack' \ ``` Also, you can use `multipart/form-data`. -For more details about `multipart/form-data`, please see [Why `in_http` removes '+' from my log](http.md#why-in_http-removes--from-my-log). +For more details about `multipart/form-data`, please see [Why `in_http` removes '+' from my log](http.md#why-inhttp-removes--from-my-log). ### Handle Other Formats using Parser Plugins diff --git a/input/syslog.md b/input/syslog.md index c1182f63..3c354a16 100644 --- a/input/syslog.md +++ b/input/syslog.md @@ -278,7 +278,7 @@ Tries to resolve hostname from IP addresses or not. Cannot set `false` when `sou | :--- | :--- | :--- | | bool | false | 1.14.0 | -Enables the TCP keepalive for sockets. See [socket article](../plugin-helper-overview/api-plugin-helper-socket.md#send_keepalive_packet-use-case) for more details. +Enables the TCP keepalive for sockets. See [socket article](../plugin-helper-overview/api-plugin-helper-socket.md#sendkeepalivepacket-use-case) for more details. ### `source_hostname_key` diff --git a/input/tail.md b/input/tail.md index b4028ce2..2447bdd8 100644 --- a/input/tail.md +++ b/input/tail.md @@ -579,7 +579,7 @@ the default Nginx access file `/var/log/nginx/access.log` is mode `0640` and own this case, several options are available to allow read access: 1. Add the `td-agent` user to the `adm` group, e.g. through `usermod -aG`, or -2. Use the [`cap_dac_read_search` capability](../deployment/linux-capability.md#capability-handling-on-in_tail) +2. Use the [`cap_dac_read_search` capability](../deployment/linux-capability.md#capability-handling-on-intail) to allow the invoking user to read the file without otherwise changing its permission bits or ownership. A bug exists in Fluentd 1.13.x where it may suppress warning logs about unreadable files. (See Fluentd PR [#3478](https://github.com/fluent/fluentd/pull/3478).) diff --git a/output/forward.md b/output/forward.md index 483fdbf0..ce609dfa 100644 --- a/output/forward.md +++ b/output/forward.md @@ -353,7 +353,7 @@ Example: You do not need any configuration in the receiving server. Data compression is auto-detected and handled transparently by the destination node. -Since v1.19.3, the receiving `in_forward` limits the decompressed chunk size to 256MB by default. See [`in_forward`](../input/forward.md#decompression_size_limit) if you need to send larger chunks. +Since v1.19.3, the receiving `in_forward` limits the decompressed chunk size to 256MB by default. See [`in_forward`](../input/forward.md#decompressionsizelimit) if you need to send larger chunks. Supported values: diff --git a/parser/README.md b/parser/README.md index 20c2cb6b..9cd2bf22 100644 --- a/parser/README.md +++ b/parser/README.md @@ -47,7 +47,7 @@ the default Nginx access file `/var/log/nginx/access.log` is mode `0640` and own this case, several options are available to allow read access: 1. Add the `td-agent` user to the `adm` group, e.g. through `usermod -aG`, or -2. Use the [`cap_dac_read_search` capability](../deployment/linux-capability.md#capability-handling-on-in_tail) +2. Use the [`cap_dac_read_search` capability](../deployment/linux-capability.md#capability-handling-on-intail) to allow the invoking user to read the file without otherwise changing its permission bits or ownership. ## List of Built-in Parsers diff --git a/parser/multiline.md b/parser/multiline.md index 709a1e80..54876459 100644 --- a/parser/multiline.md +++ b/parser/multiline.md @@ -41,7 +41,7 @@ Specifies the regexp patterns. For readability, you can separate the regexp patt If set, the lines which do not match the patterns are emitted as a record with the `unmatched_line` field instead of being discarded. -With `in_tail`, this parameter is overwritten by the value of [`emit_unmatched_lines`](../input/tail.md#emit_unmatched_lines). Set `emit_unmatched_lines` on `in_tail` instead of setting this parameter in the `` section. +With `in_tail`, this parameter is overwritten by the value of [`emit_unmatched_lines`](../input/tail.md#emitunmatchedlines). Set `emit_unmatched_lines` on `in_tail` instead of setting this parameter in the `` section. ## Example diff --git a/plugin-helper-overview/api-plugin-helper-server.md b/plugin-helper-overview/api-plugin-helper-server.md index a98843f1..f5ea3f79 100644 --- a/plugin-helper-overview/api-plugin-helper-server.md +++ b/plugin-helper-overview/api-plugin-helper-server.md @@ -67,7 +67,7 @@ The `&block` is invoked with the new connection as a parameter. * `linger_timeout`: the timeout \(seconds\) to set `SO_LINGER` * `recv_timeout`: the timeout \(seconds\) to set `SO_RECVTIMEO` * `send_timeout`: the timeout \(seconds\) to set `SO_SNDTIMEO` - * `send_keepalive_packet`: if `true`, enable TCP keep-alive via `SO_KEEPALIVE`. See also [socket article](api-plugin-helper-socket.md#send_keepalive_packet-use-case). + * `send_keepalive_packet`: if `true`, enable TCP keep-alive via `SO_KEEPALIVE`. See also [socket article](api-plugin-helper-socket.md#sendkeepalivepacket-use-case). Example: @@ -119,7 +119,7 @@ The `&block` is invoked with parameter\(s\) on data. * `linger_timeout`: the timeout \(seconds\) to set `SO_LINGER` * `recv_timeout`: the timeout \(seconds\) to set `SO_RECVTIMEO` * `send_timeout`: the timeout \(seconds\) to set `SO_SNDTIMEO` - * `send_keepalive_packet`: if `true`, enable TCP keep-alive via `SO_KEEPALIVE`. See also [socket article](api-plugin-helper-socket.md#send_keepalive_packet-use-case). + * `send_keepalive_packet`: if `true`, enable TCP keep-alive via `SO_KEEPALIVE`. See also [socket article](api-plugin-helper-socket.md#sendkeepalivepacket-use-case). Code example: