nicusX opened a new pull request, #28863:
URL: https://github.com/apache/flink/pull/28863
## What is the purpose of the change
The current Flink Glossary doc page has gaps, some inconsistencies, and
ambiguities which may be confusing for new Flink users. It also focus on
DataStream API exclusively.
This PR expands and fixes the Glossary page.
## Brief change log
### New entries (10)
- **Checkpoint**, **Savepoint**: referenced by other entries but never
defined
- **Watermark**, **Parallelism**, **Channel**, **Source Split**: absent
- **Flink SQL Statement**, **Statement Set**, **StreamExchange Operator**:
first Table API / SQL
coverage in the glossary
- **Job Graph**: promoted from an alias to a full entry
- Added 2 pointer entries: **StreamGraphs** --> Logical Graph, **Execution
Graph** --> Physical Graph
### Corrected definitions
- *Job Graph* no longer documented as a synonym of *Logical Graph*
- *Task* and **Sub-Task** no longer conflated
- *Physical Graph* fixed definition
- *Partition* split into *Logical Partitioning* and *Physical Partitioning*
sub-entries; also added note about for external system such as Kafka topic
partitions
- *State Backend* reframed as the storage itself rather than a configuration
- *Checkpoint Storage* adds the durable-storage framing and a pointer to
disaggregated state
- *(Runtime) Execution Mode* was a bare link to another page; now describes
`STREAMING` and
`BATCH` modes
- *Flink Application*: Java *or Python*, DataStream *or Table* API (was "a
Java Application").
- Fixed 3 broken cross-links that used capitalized anchors which Hugo
doesn't generate (`#Record` and `#Function`).
### Expanded entries
_Flink Job_, _Logical Graph_, _Operator_ (adds _Source/Sink Operators_ and a
note that the docs use
"Operator" loosely for Task/Sub-Task), _Operator Chain_, _Function_ (Python,
UDF, PTF), _Flink Cluster_,
_Flink JobManager_, _Flink JobMaster_, _Flink TaskManager_, _Sub-Task_
### Consistency
- Applied one capitalization rule: a defined term is capitalized when it
refers to a glossary entry
and lowercase in generic English use.
- Restored alphabetical order, disregarding the `Flink` prefix (5 entries
were misplaced). The page
sets `bookToc: false`, so ordering is the only way to locate a term.
- Retitled for consistency with sibling entries: _ExecutionGraph_ -->
_Execution Graph_,
_JobGraph_ --> _Job Graph_, _UID hash_ --> _UID Hash_
- Anchors unchanged except `#jobgraph` --> `#job-graph`, which is not
referenced outside of this page
- Added "Also <alias>" lines recording the spellings readers meet in code,
logs and the Web UI
- Removed trailing whitespace.
## Verifying this change
* Docs changes only
## 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?
- [ ] Yes (please specify the tool below)
--
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]
