Dennis-Mircea opened a new pull request, #28173:
URL: https://github.com/apache/flink/pull/28173
## What is the purpose of the change
This pull request fixes two small issues in the user-facing state backends
documentation (`docs/content/docs/ops/state/state_backends.md`):
1. A typo in the heading `### Advanced RocksDB Memory Turning` → `###
Advanced RocksDB Memory Tuning`. The body of the section uses "tuning"
correctly, confirming the heading was a slip.
2. A heading-level inconsistency under `## Available State Backends`: the
sibling subsections `### The HashMapStateBackend` and `### The
EmbeddedRocksDBStateBackend` are at level 3, but `## The ForStStateBackend` was
at level 2, implicitly closing the parent section. Demote it to `### The
ForStStateBackend` so it nests correctly under `## Available State Backends`.
## Brief change log
- `docs/content/docs/ops/state/state_backends.md`: rename the heading from
`Advanced RocksDB Memory Turning` to `Advanced RocksDB Memory Tuning`.
- `docs/content/docs/ops/state/state_backends.md`: change `## The
ForStStateBackend` to `### The ForStStateBackend` so it sits at the same
nesting level as the other backend subsections. Hugo's heading slug is
independent of level, so the existing anchor `#the-forststatebackend`
(referenced from `docs/{,.zh}/ops/state/disaggregated_state.md`) continues to
resolve.
The Chinese mirror under `docs/content.zh/` does not carry the affected
heading nor the ForStStateBackend subsection, so no parallel edits are needed
there.
## Verifying this change
This change is a trivial rework / code cleanup without any test coverage.
## Does this pull request potentially affect one of the following parts:
- Dependencies (does it add or upgrade a dependency): no
- The public API, i.e., is any changed class annotated with
`@Public(Evolving)`: no
- The serializers: no
- The runtime per-record code paths (performance sensitive): no
- Anything that affects deployment or recovery: JobManager (and its
components), Checkpointing, Kubernetes/Yarn, ZooKeeper: no
- The S3 file system connector: no
## Documentation
- Does this pull request introduce a new feature? no
- If yes, how is the feature documented? not applicable
---
##### Was generative AI tooling used to co-author this PR?
<!--
If generative AI tooling has been used in the process of authoring this PR,
please
change the checkbox below to `[X]` followed by the name of the tool, and
uncomment the
"Generated-by" line. See the ASF Generative Tooling Guidance for details:
https://www.apache.org/legal/generative-tooling.html
You are responsible for the quality and correctness of every change in this
PR
regardless of the tooling used. Low-effort AI-generated PRs will be closed.
See
AGENTS.md for the full guidance.
-->
- [ ] Yes (please specify the tool below)
<!--
Generated-by: [Tool Name and Version]
-->
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
