Opened 9 years ago

Closed 9 years ago

#24943 closed Cleanup/optimization (fixed)

Update contributing tutorial to use virtualenv

Reported by: Tim Graham Owned by: Markus Amalthea Magnuson
Component: Documentation Version: dev
Severity: Normal Keywords:
Cc: markus.magnuson@… Triage Stage: Ready for checkin
Has patch: yes Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: no UI/UX: no

Description

We should assume Python 3 which (usually) includes virtualenv. There are some caveats, but many can be adapted from the ​Django Girls tutorial.

Change History (10)

comment:1 by Markus Amalthea Magnuson, 9 years ago

Cc: markus.magnuson@… added
Owner: changed from nobody to Markus Amalthea Magnuson
Status: new → assigned

comment:2 by Markus Amalthea Magnuson, 9 years ago

Has patch: set

I've opened a pull request for this even though there are some parts left to do, just to get some initial thoughts:

​https://github.com/django/django/pull/4835

What do you think? Here are some of my own notes:

  • Should we mention initially that Python 3 is assumed throughout?
  • Should we add Windows specific instructions along the way?

As you mentioned in the descriptions, there are some caveats that might be useful, that we could borrow from Django Girls.

  • Should all of them be included?
  • How should we do proper attribution if using materials from there?

comment:3 by Markus Amalthea Magnuson, 9 years ago

Seems like one test set failed on last push due to some random hickup:

​http://djangoci.com/job/pull-requests-trusty/2071/database=mysql,label=trusty-pr,python=python3.4/console

How can I retrigger the build without making any changes to the branch?

comment:4 by Tim Graham, 9 years ago

Yes, we need to say that Python 3 is required. Notes for Windows are okay.

Use your judgement on the caveats. I am not sure about attribution as it seems parts of thir chapter comes from other sources too. We usually give credits only in AUTHORS.

Don't worry about the build failure. It's an occasional hiccup.

comment:5 by Markus Amalthea Magnuson, 9 years ago

Updated the pull request with some notes and Windows instructions, have another look.

I'm not at a Windows computer right now, but I would want to go through the entire tutorial on Windows before this is merged. Hopefully that can happen later today.

(Still getting similar build failures, but for other jobs.)

comment:6 by Markus Amalthea Magnuson, 9 years ago

Also note that the Windows code blocks use 'none' for Pygments, ​any of the shell types would generate quite confusing syntax highlighting, at least locally.

comment:7 by Tim Graham, 9 years ago

Patch needs improvement: set

Looking good.

comment:8 by Markus Amalthea Magnuson, 9 years ago

Patch needs improvement: unset

Updated the pull request according to review, see notes in PR comments.

comment:9 by Tim Graham, 9 years ago

Triage Stage: Accepted → Ready for checkin

comment:10 by Tim Graham <timograham@…>, 9 years ago

Resolution: → fixed
Status: assigned → closed

In fb1ba4d:

Fixed #24943 -- Updated contributing tutorial to use virtualenv

Note: See TracTickets for help on using tickets.
Back to Top