Problem

The documentation site offers an "Edit This Page" button at the bottom of most pages (example), 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 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.

Solution

Edit the anchor (source) 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.

Attachments

Issue Links

links to

GitHub Pull Request #24915

Activity

People

Assignee:: Unassigned

Reporter:: Matt Braymer-Hayes

Votes:: 0 Vote for this issue

Watchers:: 1 Start watching this issue

Dates

Created:: 07/Jun/24 14:21

Updated:: 26/Jun/24 18:53