ChenXi created KAFKA-21529:
------------------------------
Summary: Streams documentation links point to section anchors that
no longer exist
Key: KAFKA-21529
URL: https://issues.apache.org/jira/browse/KAFKA-21529
Project: Kafka
Issue Type: Task
Components: docs, streams
Reporter: ChenXi
h3. Summary:
Several Kafka Streams documentation pages still link to pre-migration section
anchors that no longer exist on the target pages. Clicking such a link opens
the target page but stays at the top instead of scrolling to the intended
section.
65 cross-page links across 10 Streams documentation files:
|File|Broken links|
|docs/streams/developer-guide/dsl-api.md|27|
|docs/streams/developer-guide/write-streams-app.md|9|
|docs/streams/developer-guide/memory-mgmt.md|6|
|docs/streams/developer-guide/running-app.md|6|
|docs/streams/developer-guide/config-streams.md|5|
|docs/streams/developer-guide/datatypes.md|4|
|docs/streams/developer-guide/interactive-queries.md|3|
|docs/streams/developer-guide/manage-topics.md|2|
|docs/streams/developer-guide/app-reset-tool.md|2|
|docs/streams/developer-guide/testing.md|1|
h3. Examples:
* {{../dsl-api#streams-developer-guide-dsl-aggregating}} ->
{{../dsl-api#aggregating}}
* {{../../core-concepts#streams_processor_node}} ->
{{../../core-concepts#stream-processing-topology}}
* {{../processor-api#streams-developer-guide-state-store}} ->
{{../processor-api#state-stores}}
* {{../dsl-api#streams-developer-guide-dsl}} -> {{../dsl-api#overview}}
(whole-page anchor now points to the page's first section)
* {{./#testing-topologytestdriver}} -> {{./#testing-a-streams-application}}
h3. Root cause
The documentation was migrated to the Hugo page structure. Heading slugs and
explicit anchors changed, and some sections became standalone pages, but many
cross-page links kept the old anchor names ({{{}#streams_processor_node{}}},
{{{}#streams-developer-guide-dsl-aggregating{}}},
{{{}#streams-developer-guide-serdes{}}}, ...).
Note:The PR
[(https://github.com/apache/kafka/pull/22813)|https://github.com/apache/kafka/pull/22813%EF%BC%89%EF%BC%8C%E4%B8%8D%E6%98%AF]
fixed broken relative paths but did not update the anchors.
h3. Expected behavior
Each link points to an anchor that currently exists on the target page (or to
the page's first section when the old anchor denoted a whole section/page).
h3. Scope / impact
* Documentation only; no code, API, protocol, or configuration changes.
* No KIP required.
--
This message was sent by Atlassian Jira
(v10.3.26#10030026)