Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
pradyunsg opened this issue Jan 12, 2022 · 2 comments
Labels
type: enhancement A self-contained enhancement or new feature

Comments

@pradyunsg
Copy link
Member

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.
@pradyunsg pradyunsg added the type: enhancement A self-contained enhancement or new feature label Jan 12, 2022
@pradyunsg
Copy link
Member Author

To be clear, this doesn't mean we need to change the actual content or maybe even change the URLs -- it's more a matter of making sure that the user flow through the documentation is one that leads them to the right places more easily and quickly.

@bhrutledge
Copy link
Contributor

@pradyunsg I'm intrigued. Could you give some concrete examples of how the current content would fit into the audience categories you described? Bonus points for linking to the current page.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: enhancement A self-contained enhancement or new feature
Projects
None yet
Development

No branches or pull requests

3 participants
@bhrutledge @pradyunsg and others