Matt Braymer-Hayes created FLINK-35558:
------------------------------------------
Summary: [docs] "Edit This Page" tool does not follow contribution
guidelines
Key: FLINK-35558
URL: https://issues.apache.org/jira/browse/FLINK-35558
Project: Flink
Issue Type: Improvement
Components: Documentation
Reporter: Matt Braymer-Hayes
h1. Problem
The [documentation
site|https://nightlies.apache.org/flink/flink-docs-release-1.19/] offers an
"Edit This Page" button at the bottom of most pages
([example|https://nightlies.apache.org/flink/flink-docs-release-1.19/docs/try-flink/local_installation/#summary]),
allowing a user to quickly open a GitHub PR to resolve the issue.
Unfortunately this feature uses the version branch (e.g., {{{}release-1.19{}}})
as the base, whereas the [documentation contribution
guide|https://flink.apache.org/how-to-contribute/contribute-documentation/#submit-your-contribution]
expects {{master}} to be the base. Since these release branches are often
incompatible with {{master}} (i.e., I can't do a simple rebase or merge), I end
up not being able to use the "Edit This Page" feature and instead have to make
the change myself on GitHub or locally.
h1. Solution
Edit the anchor
([source|https://github.com/apache/flink/blob/57869c11687e0053a242c90623779c0c7336cd33/docs/layouts/partials/docs/footer.html#L30])
to use {{master}} instead of {{{}.Site.Params.Branch{}}}. This would lower the
barrier to entry significantly for docs changes and allow the "Edit This Page"
feature to work as intended.
--
This message was sent by Atlassian Jira
(v8.20.10#820010)
