[tracking] new tutorials and other revisions #194

Open
ddbeck opened this Issue Dec 3, 2015 · 16 comments

Comments

Projects
None yet
8 participants
@ddbeck
Contributor

ddbeck commented Dec 3, 2015

This issue is to track work on writing new, introductory tutorials for the guide, and other activities that are part of an effort to expand and revise the guide. See this thread from the distutils-sig for more details about this project. Work on these tutorials will (at least initially) take place on the develop branch.

I am inviting the group of volunteers to use this issue to see what other issues are available and to use this as a place for general questions and help (i.e., questions that are not issue-specific), to minimize noise on other issues and the creation of new issues.

If you'd like to contribute to these sections, please see the (to be) linked issues for details. Additionally, please review the developing guide to contributing. If you start work on an issue, please consider saying so on the relevant issue, so others don't duplicate your work. Thanks!

Outline

Broadly, the new intro to packaging tutorials have the following outline:

  1. Who is this for?
  2. Prerequisites
  3. What's a package?
  4. Where do packages come from?
  5. Install your first package
  6. Use a virtual environment
  7. Make your first package
  8. Publish your first package

Issues will soon be created to address each section specifically; the outline above will link to each section's issue.

Bite size tasks

  • #207: Add build instructions to the README

Extra style notes

The intro to packaging tutorials have some extra style considerations on top of that of the guide generally:

  • In contrast to more task-focused writing, the tutorials are meant to build fundamental packaging skills, rather than resolve a specific problem. With that in mind, try to invite readers to learn to do something without regard for its specific applications. So instead of something like "Read this section if you want to share a package…" try "After you complete this section, you'll be able to share a package…"
@souravsingh

This comment has been minimized.

Show comment
Hide comment
@souravsingh

souravsingh Dec 4, 2015

I would like to work on the first two parts of the tutorial.

I would like to work on the first two parts of the tutorial.

@ddbeck

This comment has been minimized.

Show comment
Hide comment
@ddbeck

ddbeck Dec 4, 2015

Contributor

@souravsingh That's great! I would suggest picking one to begin with and, as you make progress, mention that you're working on it in the section-specific issue (so others don't duplicate your work). Let me know if you have any questions. Thanks!

Contributor

ddbeck commented Dec 4, 2015

@souravsingh That's great! I would suggest picking one to begin with and, as you make progress, mention that you're working on it in the section-specific issue (so others don't duplicate your work). Let me know if you have any questions. Thanks!

@thatdocslady

This comment has been minimized.

Show comment
Hide comment
@thatdocslady

thatdocslady Dec 8, 2015

I'll be happy to help with content reviews (proofreading, editing) and overall structure, unfortunately I don't have enough bandwidth at the moment to write content from scratch :-( feel free to assign any content that needs review to me :-)

I'll be happy to help with content reviews (proofreading, editing) and overall structure, unfortunately I don't have enough bandwidth at the moment to write content from scratch :-( feel free to assign any content that needs review to me :-)

@souravsingh

This comment has been minimized.

Show comment
Hide comment
@souravsingh

souravsingh Dec 8, 2015

Thanks for the help @thatdocslady

Thanks for the help @thatdocslady

@alexwlchan

This comment has been minimized.

Show comment
Hide comment
@alexwlchan

alexwlchan Dec 8, 2015

Contributor

Like thatdocslady, I'm happy to take on review tasks if it's useful, but I can't promise any original content (things are all a bit up-in-the-air at the moment).

Contributor

alexwlchan commented Dec 8, 2015

Like thatdocslady, I'm happy to take on review tasks if it's useful, but I can't promise any original content (things are all a bit up-in-the-air at the moment).

@ddbeck

This comment has been minimized.

Show comment
Hide comment
@ddbeck

ddbeck Dec 8, 2015

Contributor

@thatdocslady @alexwlchan thank you both for volunteering! As sections become stable, I'll definitely call on you to be a new set of eyes.

Contributor

ddbeck commented Dec 8, 2015

@thatdocslady @alexwlchan thank you both for volunteering! As sections become stable, I'll definitely call on you to be a new set of eyes.

@dsmatlak

This comment has been minimized.

Show comment
Hide comment
@dsmatlak

dsmatlak Dec 11, 2015

I want to learn about Python and participate in this project by either writing, researching, or proofreading. If you have any suggestions for a Python newbie, please let me know. Thanks :)

I want to learn about Python and participate in this project by either writing, researching, or proofreading. If you have any suggestions for a Python newbie, please let me know. Thanks :)

@ddbeck

This comment has been minimized.

Show comment
Hide comment
@ddbeck

ddbeck Dec 14, 2015

Contributor

@dsmatlak Great, I think you're in the right place. Since you're new to Python, I think it would be a big help if you could test out the new tutorial sections as they are written. I'm also planning to work on writing up some bite-size issues that might be a little more manageable than writing a whole new section. I'm planning to tag issues soon and update here when we get to that point. Thanks for your interest!

Contributor

ddbeck commented Dec 14, 2015

@dsmatlak Great, I think you're in the right place. Since you're new to Python, I think it would be a big help if you could test out the new tutorial sections as they are written. I'm also planning to work on writing up some bite-size issues that might be a little more manageable than writing a whole new section. I'm planning to tag issues soon and update here when we get to that point. Thanks for your interest!

@dsmatlak

This comment has been minimized.

Show comment
Hide comment
@dsmatlak

dsmatlak Dec 16, 2015

@ddbeck Excellent, sounds good.

@ddbeck Excellent, sounds good.

ddbeck pushed a commit that referenced this issue Feb 7, 2016

Daniel D. Beck
create TOC for new packaging tutorials and add to root TOC
This completes the work required to merge PR #211 (corresponding to issue #202)
also included as part of issue #194.

@ddbeck ddbeck referenced this issue Apr 5, 2016

Closed

Prerequisites #214

@azibit

This comment has been minimized.

Show comment
Hide comment
@azibit

azibit Feb 18, 2017

Woow, Just came across this issue and I would really love to be of help

azibit commented Feb 18, 2017

Woow, Just came across this issue and I would really love to be of help

@ddbeck

This comment has been minimized.

Show comment
Hide comment
@ddbeck

ddbeck Feb 18, 2017

Contributor

@azibit thanks for your interest! This has fallen by the wayside a little bit, but I'll have more time to work on this project in the next couple weeks, I expect. Take a look at some of the issues linked from the outline and see if there's something specific you'd like to work on. Happy to provide any specific guidance or help, as needed.

Contributor

ddbeck commented Feb 18, 2017

@azibit thanks for your interest! This has fallen by the wayside a little bit, but I'll have more time to work on this project in the next couple weeks, I expect. Take a look at some of the issues linked from the outline and see if there's something specific you'd like to work on. Happy to provide any specific guidance or help, as needed.

@ghost

This comment has been minimized.

Show comment
Hide comment
@ghost

ghost Apr 13, 2017

I'd love to contribute a bit to this. I'm doing a bootcamp and would like to practice adding to documentation and potentially some code. Thanks.

ghost commented Apr 13, 2017

I'd love to contribute a bit to this. I'm doing a bootcamp and would like to practice adding to documentation and potentially some code. Thanks.

@theacodes

This comment has been minimized.

Show comment
Hide comment
@theacodes

theacodes Apr 14, 2017

Member

@jonfujita as mentioned in @ddbeck's comment, this has fallen a bit by the wayside but if there's any particular topic you want to pursue let us know and we can provide some guidance.

Member

theacodes commented Apr 14, 2017

@jonfujita as mentioned in @ddbeck's comment, this has fallen a bit by the wayside but if there's any particular topic you want to pursue let us know and we can provide some guidance.

@ddbeck

This comment has been minimized.

Show comment
Hide comment
@ddbeck

ddbeck Apr 14, 2017

Contributor

@jonparrott Oh jeez that couple weeks thing was… optimistic. I've noticed you've brought on a lot of activity on the repo, triaging open issues and PRs. Did you have any long term plans that I can coordinate with (or at least not get in the way of), especially when it comes to these tutorials?

Contributor

ddbeck commented Apr 14, 2017

@jonparrott Oh jeez that couple weeks thing was… optimistic. I've noticed you've brought on a lot of activity on the repo, triaging open issues and PRs. Did you have any long term plans that I can coordinate with (or at least not get in the way of), especially when it comes to these tutorials?

@theacodes

This comment has been minimized.

Show comment
Hide comment
@theacodes

theacodes Apr 14, 2017

Member

@ddbeck still getting my head around all of this so I'm doing some baby steps (both for my own benefit and to not rustle feathers by changing everything at one). I'll let you know once I'm a bit more comfortable (and feel free to nag me).

Member

theacodes commented Apr 14, 2017

@ddbeck still getting my head around all of this so I'm doing some baby steps (both for my own benefit and to not rustle feathers by changing everything at one). I'll let you know once I'm a bit more comfortable (and feel free to nag me).

@theacodes theacodes referenced this issue May 26, 2017

Closed

Master documentation plan #317

6 of 6 tasks complete
@aryan-harsh

This comment has been minimized.

Show comment
Hide comment
@aryan-harsh

aryan-harsh Jun 23, 2018

@ddbeck @theacodes is there any work left to do? can i help in any way. i do not know much of python, but am good with content writing.

@ddbeck @theacodes is there any work left to do? can i help in any way. i do not know much of python, but am good with content writing.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment