[tracking] new tutorials and other revisions

[ddbeck]

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

• Add build instructions to the README #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]

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

[ddbeck]

@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]

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]

Thanks for the help @thatdocslady

[alexwlchan]

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]

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

[ghost]

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]

@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!

[ghost]

@ddbeck Excellent, sounds good.

[azibit]

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

[ddbeck]

@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]

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]

@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]

@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]

@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).

[aryan-harsh]

@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.

[Venu-Gopal18]

@ddbeck I am good at content writing and well aware of python . Is there anything I can do? I want to be participate as active as possible cuz I'm new

[lorarjohns]

I'd love to contribute content on virtual environments.

I can also get into managing and deploying packages with Docker Compose; pytest and Fabric/GitHub CI/CD workflows with VSCode, and packaging vs 'developing' for different tools and different objectives, if you like. I have a teaching and research background and really enjoy making tutorials 😄

[Lawrence-Krukrubo]

Hey guys, how can I contribute. I'm a top writer in Artificial intelligence in the Medium and I love to code. please let me know where I can best fit in

[ihzarizkyk]

how to make the first package? ... because I'm very interested

[rneelas]

@ddbeck is there any open tutorials to which I can contribute? Please do let me know, more happy to write up

[freek-sonal]

@ddbeck i would like to start contributing in open source. And while learning, i wanted to contribute in writing tutorials. Please let me know if you have any work i can contribute to.

[dayvheed]

Hi @ddbeck. I am a technical content writer that has written a couple of blog tutorials in Python and ML. I would love to contribute to this project in any way possible. Please let me know if there's something I can do

[webknjaz]

@dayvheed there's a recently requested package deprecation guide: #883. Do you want to propose a PR on this topic? There's pointers in that issue one could start exploring and converting into an RST file.

[dayvheed]

@webknjaz thanks a lot. I just checked it out. So if I get the thread right, the author wants to inform users that manimce is obsolete and manim should rather be installed.

I can then write a documentation of the things around this development. Is that correct please?

[webknjaz]

Yep. That's right, also let's move the discussion related to the specific guide to that document or to a PR — if you want to start with submitting an unfinished draft and update it as you add new things there. You may want to take a look at other guides and attempt to match that style.

[dayvheed]

Thank you. I have moved further discussions there.

[sdkdeepa]

Hello, I would like to contribute to this documentation. Please let me know where I could start. Thank you!

[joyjoseph]

I would love to be part of this. please how do I contribute?

[maziokey]

I would love to help in any way I can. Documentation or any other thing to be done. thank you

[pradyunsg]

Hi folks! If you're interested in contributing to this documentation, please see the issues labelled as good first issue.

I'm going to go ahead and close this one, since (a) there are tracking issues for each individual part of this issue and (b) I'm pretty sure most of the current maintainers do not have the context necessary to know what this issue was scoped as originally.

[navaneethnpk]

Hi, I am an open-source enthusiast. It is difficult to start contributing to open-source projects because it's way too many. I came here from a blog post. I would love to join this community and contribute. Please let me know what to do. Thanks 😄

[pradyunsg]

Looks like spam bots have decided that this is a good issue to spam. A different maintainer locked this to avoid more spam being spewed here.