classification
Title: All Sphinx generated pages could have a new "Edit This Page" link adjacent to the existing "Show Source"
Type: Stage:
Components: Documentation Versions: Python 3.11
process
Status: open Resolution:
Dependencies: Superseder:
Assigned To: docs@python Nosy List: Mariatta, Paul Hammant, docs@python, fdrake, iritkatriel, r.david.murray
Priority: normal Keywords:

Created on 2017-07-27 12:45 by Paul Hammant, last changed 2021-04-25 18:13 by iritkatriel.

Messages (7)
msg299306 - (view) Author: Paul Hammant (Paul Hammant) Date: 2017-07-27 12:45
Show Source links to: https://github.com/python/cpython/blob/path/to/resource.rst

Edit This Page would link to
https://github.com/python/cpython/edit/path/to/resource.rst

And yes, GitHub does the right thing if you're not ordinarily permitted to change python/cpython
msg299325 - (view) Author: Mariatta (Mariatta) * (Python committer) Date: 2017-07-27 17:03
I don't think we should add this link.

When we make edits to the docs, even simple typo fixes, it should first be done in the master branch, instead of the maintenance branches (e.g. 2.7, 3.5 or 3.6).

If "Edit This Page" link takes you to edit the documentation in branches other than "master", that's not desirable workflow.

If "Edit This Page" link takes you to edit the master branch, it can be confusing to the contributor since the content on "master" might be different.
msg299336 - (view) Author: Fred Drake (fdrake) (Python committer) Date: 2017-07-27 19:01
On Thu, Jul 27, 2017 at 1:03 PM, Mariatta Wijaya <report@bugs.python.org> wrote:
> I don't think we should add this link.
>
> When we make edits to the docs, even simple typo fixes, it should first be done
> in the master branch, instead of the maintenance branches (e.g. 2.7, 3.5 or 3.6).
>
> If "Edit This Page" link takes you to edit the documentation in branches other
> than "master", that's not desirable workflow.
>
> If "Edit This Page" link takes you to edit the master branch, it can be confusing
> to the contributor since the content on "master" might be different.

I wonder if a better solution lies somewhere between the original
suggestion and just
not including such a link.

If the link went to an edit form with the version of the content the
user was reading,
and includes an explanation of the multiple-versions issue, it might
prove reasonable
to try applying the diff between the modified and original text to the
HEADs of each
maintenance branch.  If the diff doesn't apply, the (possibly new)
contributor can be
offered a chance to deal with edits to each version (which might be a bit much).

At any rate, the diff could be used to construct a temporary branch,
b.p.o issue, and
PR. This would allow us to provide the contributor with a way to see
that their suggested
changes are being considered, and we're less likely to lose them in a
wall of email.

There'd be a bit of work to make all this play out, though.

  -Fred
msg299337 - (view) Author: Fred Drake (fdrake) (Python committer) Date: 2017-07-27 19:04
On Thu, Jul 27, 2017 at 3:01 PM, Fred L. Drake, Jr.
<report@bugs.python.org> wrote:
> If the link went to an edit form with the version of the content the
> user was reading,
> and includes an explanation of the multiple-versions issue, it might
> prove reasonable

Egads, look at that formatting!

Somedays I miss my VT-100 terminals and sane line handling.

  -Fred
msg299338 - (view) Author: Paul Hammant (Paul Hammant) Date: 2017-07-27 19:34
Hi folks, I'm not explaining Github's non-commiter contribution process very well.

Click this link everyone - https://github.com/BuildRadiator/BuildRadiator/edit/master/README.md - pretend to make a contribution to one of my projects :)
msg299343 - (view) Author: R. David Murray (r.david.murray) * (Python committer) Date: 2017-07-27 19:56
No, we understand the process, the problem is that except for the 'dev' docs, the link would be to a branch other than master.  That's the problem that we're discussing.

Maybe instead of an edit link on non-dev docs we could have a message saying that if you want to propose a change you can use the edit link on the 'dev' version of the docs?  Maybe with a link or button that would take them to the dev version of the page?
msg391865 - (view) Author: Irit Katriel (iritkatriel) * (Python committer) Date: 2021-04-25 18:13
Another option is to just add a link to https://devguide.python.org/docquality/
History
Date User Action Args
2021-04-25 18:13:44iritkatrielsetnosy: + iritkatriel

messages: + msg391865
versions: + Python 3.11, - Python 2.7
2017-07-27 19:56:23r.david.murraysetnosy: + r.david.murray
messages: + msg299343
2017-07-27 19:34:27Paul Hammantsetmessages: + msg299338
2017-07-27 19:04:23fdrakesetmessages: + msg299337
2017-07-27 19:01:58fdrakesetnosy: + fdrake
messages: + msg299336
2017-07-27 17:03:21Mariattasetnosy: + Mariatta
messages: + msg299325
2017-07-27 12:45:26Paul Hammantcreate