pypa / pypa/packaging.python.org

Restructure this guide to be organised for intended audience, rather topics/style of content

Open
#1,039 2 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

type: enhancement
Dominant language
Python
Stars
1.7k
Forks
1.7k
Avg merge
3d 12h
Merged PRs (30d)
4

Description

Currently, this guide has a somewhat awkward content structure IMO. As it stands, I believe it is difficult to find answers to the specific questions you might care about, unless you know exactly what you're looking for.

One of the ways that we can improve this would be to pivot the guide away from organising content as "tutorials" / "guides" etc, and more toward separating content on the basis of the audience that would want to read it. A potential split of audiences based on "what you might be interested in" would be:

  • "consumer": Using Python packages
  • "author": Author/maintainer of Python software (that likely also uses Python packages)
  • "tooling-author": Author/maintainer of a tool that interacts with Python packages / index etc.
  • "contributor" : People who wish to contribute to this guide, specifically.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the guide's current content structure and navigation, then compare it with the proposed consumer, author, tooling-author, and contributor audiences. Done means the guide is reorganized around those audiences so readers can find answers based on what they want to do.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.