[FLINK-39237][Doc] Decouple flink-training links from the Flink branch#27751
Open
joeyutong wants to merge 2 commits intoapache:masterfrom
Open
[FLINK-39237][Doc] Decouple flink-training links from the Flink branch#27751joeyutong wants to merge 2 commits intoapache:masterfrom
joeyutong wants to merge 2 commits intoapache:masterfrom
Conversation
Collaborator
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What is the purpose of the change
This fixes broken
flink-traininglinks in the docs on release branches.Today the
training_linkshortcode usesSite.Params.Branch, which is updated to values such asrelease-2.2when a new Flink docs branch is created. Theapache/flink-trainingrepository does not create matching release branches, so those links resolve to non-existent GitHub paths and return 404s.Brief change log
This change introduces a dedicated
TrainingExercisesBranchconfig entry and updates the training shortcodes to use it instead of the Flink docsBranch.TrainingExercisesBranch = "master"todocs/config.tomltraining_link.htmlto useTrainingExercisesBranchtraining_repo.htmlto useTrainingExercisesBranchVerifying this change
Build and verify the docs in local.
Does this pull request potentially affect one of the following parts:
@Public(Evolving): noDocumentation