This issue tracker has been migrated to GitHub, and is currently read-only.
For more information, see the GitHub FAQs in the Python's Developer Guide.

classification
Title: Update DevGuide link in Quickstart Step 1
Type: behavior Stage: resolved
Components: Devguide Versions:
process
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: Nosy List: berker.peksag, ezio.melotti, python-dev, ttz, willingc
Priority: normal Keywords: patch

Created on 2015-04-13 13:39 by willingc, last changed 2022-04-11 14:58 by admin. This issue is now closed.

Files
File name Uploaded Description Edit
patch23931.patch ttz, 2015-04-13 15:36
patch23931v0_1.patch ttz, 2015-04-13 16:47 second version of patch
iss23931.patch willingc, 2015-07-28 06:54
Messages (10)
msg240605 - (view) Author: Carol Willing (willingc) * (Python committer) Date: 2015-04-13 13:39
Change Quickstart step 1 link to redirect to Section 1.1 Getting Started. Currently, it redirects to 1.1.2 Getting the Source Code. For developers coming from git, step 1.1.1 Version Control Setup would be helpful.

Feedback from PyCon 2015 Sprints suggest this change.
msg240622 - (view) Author: Tina Zhang (ttz) Date: 2015-04-13 15:23
Link now goes to 1.1 Getting Set Up so step 1.1.1. Version COntrol section is visible
msg240625 - (view) Author: Tina Zhang (ttz) Date: 2015-04-13 15:36
adding patch!
msg240652 - (view) Author: Tina Zhang (ttz) Date: 2015-04-13 16:47
Link goes to 1.1.1 instead of 1.1
msg240753 - (view) Author: Carol Willing (willingc) * (Python committer) Date: 2015-04-13 21:08
@ezio.melotti I've reviewed the second version of the patch and it links as you requested to 1.1.1. It is ready to be merged.

Thanks ttz.
msg240776 - (view) Author: Berker Peksag (berker.peksag) * (Python committer) Date: 2015-04-13 22:05
Thanks for the patch, but I think the current link is correct. Contributors will need to read the whole page anyway :)

If you want to mention https://docs.python.org/devguide/setup.html#version-control-setup in index.rst, I'd suggest something like this:

1. :ref:`Get the source code <checkout>`::
 
       hg clone https://hg.python.org/cpython

   See :ref:`vcsetup` on installing Mercurial.
msg240783 - (view) Author: Carol Willing (willingc) * (Python committer) Date: 2015-04-13 22:16
@berker.peksag I think that new contributors (esp. those at the sprints) want to get started quickly. Many do not read the whole devguide before starting even though the devguide is really helpful.

I like your suggested approach to keep the original link and add the "See ..."
phrase. Thanks :)
msg247504 - (view) Author: Carol Willing (willingc) * (Python committer) Date: 2015-07-28 06:54
Berker, Thanks for restaging this issue. I have attached a patch which implements your suggested approach. If you have time to review and commit, I would appreciate the help.
msg247515 - (view) Author: Roundup Robot (python-dev) (Python triager) Date: 2015-07-28 11:14
New changeset 6b9c91135e1b by Berker Peksag in branch 'default':
Issue #23931: Add a link to the "Version Control Setup" section in index.rst.
https://hg.python.org/devguide/rev/6b9c91135e1b
msg247516 - (view) Author: Berker Peksag (berker.peksag) * (Python committer) Date: 2015-07-28 11:15
Looks great! Thank you Tina and Carol :)
History
Date User Action Args
2022-04-11 14:58:15adminsetgithub: 68119
2015-07-28 11:15:53berker.peksagsetstatus: open -> closed
resolution: fixed
messages: + msg247516

stage: patch review -> resolved
2015-07-28 11:14:25python-devsetnosy: + python-dev
messages: + msg247515
2015-07-28 06:54:31willingcsetfiles: + iss23931.patch

messages: + msg247504
stage: needs patch -> patch review
2015-07-27 23:40:14berker.peksagsetstage: commit review -> needs patch
2015-04-13 22:16:47willingcsetmessages: + msg240783
2015-04-13 22:05:05berker.peksagsetnosy: + berker.peksag
messages: + msg240776
2015-04-13 21:26:31willingcsetstage: commit review
2015-04-13 21:08:20willingcsetmessages: + msg240753
2015-04-13 16:47:40ttzsetfiles: + patch23931v0_1.patch

messages: + msg240652
2015-04-13 15:36:35ttzsetfiles: + patch23931.patch
keywords: + patch
messages: + msg240625
2015-04-13 15:23:00ttzsetnosy: + ttz
messages: + msg240622
2015-04-13 13:39:49willingccreate