owncloud
The "Edit this page" link should point to master
- Open https://doc.owncloud.com
- The browser gets redirected to (currently) https://doc.owncloud.com/server/10.6/ OK
- It is prominently visible that the documentation exists for multiple server versions. (Highlights in green). OK
- The "Edit this page" link suggests editing source in the github branch
10.6(Highlight in red). BAD
Due to this, pull requests are being opened against version branches. I am guilty of blindly following this default setting in the past myself. This results in miscommunications, and broken pull requests. I have tried to later redirect some of my PRs to master. Github does not handle that well. It probably requires detailled insights in how github (rebase?) works. We should not expect that from community documentation volunteers.
Suggested enhancement:
- instead of a direct link to the github version branch, introduce a confirmation requester "You are about to edit branch "10.6". To submit documentation updates, please cancel and switch to "master". [OK] [Cancel]
instead of a direct link to the github version branch...
this is a very good idea to add a description upfront 👍 We could design some text, like I have dropped you and more, which would help readers and contributors to see the impact and revise if the current approach is the correct one.
A kind of intermediate page, inbetween docs and github:
docs --> edit description page (ok) --> github
docs <-- edit description page (back)
In the framework that builds the docs, is there any way to tell it to replace the 10.* with master when building the "edit this page" link?
The reason for editing a particular branch can be necessary. Maybe there is a need because the change only addresses this branch. Therefore I would not disable that by default.
In the framework that builds the docs, is there any way to tell it to replace the
10.*withmasterwhen building the "edit this page" link?
https://docs.antora.org/antora/2.2/playbook/configure-edit-url/#customize-the-edit-url
