[
https://issues.apache.org/jira/browse/FLINK-39237?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Yu Tang updated FLINK-39237:
----------------------------
Description:
In the Flink docs site, training exercise links are generated through the
{{training_link}} shortcode.
At the moment, this shortcode uses the shared {{Branch}} value from
{{docs/config.toml}}. When a new Flink release branch is created, {{Branch}} is
updated to values such as {{release-2.2}}. However, the
{{apache/flink-training}} repository does not create matching release branches.
As a result, training links in docs pages such as
{{docs/content/docs/learn-flink/event_driven.md}} point to non-existent GitHub
paths and return 404 pages.
This creates broken documentation links on release branches.
*Proposed improvement*
Introduce a dedicated config value for the training repository branch, separate
from the main Flink docs branch, and update the training shortcodes to use that
value.
was:
In the Flink docs site, training exercise links are generated through the
`training_link` shortcode.
At the moment, this shortcode uses the shared `Branch` value from
`docs/config.toml`. When a new Flink
release branch is created, `Branch` is updated to values such as
`release-2.2`. However, the `apache/flink-
training` repository does not create matching release branches. As a result,
training links in docs pages
such as `docs/content/docs/learn-flink/event_driven.md` point to non-existent
GitHub paths and return 404
pages.
This creates broken documentation links on release branches.
Proposed improvement:
Introduce a dedicated config value for the training repository branch,
separate from the main Flink docs
branch, and update the training shortcodes to use that value.
> Docs training links should not depend on the Flink release branch
> -----------------------------------------------------------------
>
> Key: FLINK-39237
> URL: https://issues.apache.org/jira/browse/FLINK-39237
> Project: Flink
> Issue Type: Improvement
> Components: Documentation
> Reporter: Yu Tang
> Priority: Major
>
> In the Flink docs site, training exercise links are generated through the
> {{training_link}} shortcode.
> At the moment, this shortcode uses the shared {{Branch}} value from
> {{docs/config.toml}}. When a new Flink release branch is created, {{Branch}}
> is updated to values such as {{release-2.2}}. However, the
> {{apache/flink-training}} repository does not create matching release
> branches. As a result, training links in docs pages such as
> {{docs/content/docs/learn-flink/event_driven.md}} point to non-existent
> GitHub paths and return 404 pages.
> This creates broken documentation links on release branches.
> *Proposed improvement*
> Introduce a dedicated config value for the training repository branch,
> separate from the main Flink docs branch, and update the training shortcodes
> to use that value.
--
This message was sent by Atlassian Jira
(v8.20.10#820010)
