pypa / pypa/packaging.python.org

Unifying packaging.python.org with pypa.io, possibly other PyPA docs too

Aperta
#846 10 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

type: task
Lingua principale
Python
Stelle
1.7k
Fork
1.7k
Merge medio
3g 12h
PR unite (30g)
4

Descrizione

We have a few web properties that represent "Python Packaging":

I'd like to propose unifying at least the first two, by rolling pypa.io into packaging.python.org, and making packaging.python.org more of a "landing page for Python packaging" (which would mostly include the existing content, but also content about what the PyPA is, brought from pypa.io)

I'd also like to move anything that's not directly related to developing PyPI and more related to using PyPI (like https://warehouse.pypa.io/api-reference/index.html) to packaging.python.org, and generally make it a policy that:

  • packging.python.org is for end users
  • Warehouse docs are for Warehouse contributors and maintainers

(This would be easy because the Warehouse docs are mostly for maintainers/contributors, and very little for end-users.)

This leaves other project-specific docs, like the pip docs, which are mostly for end-users, but also contain some development guides. Some possibilities:

  • Nothing changes, they continue to live at *.pypa.io but pypa.io redirects to packaging.python.org
  • They live at *.packaging.python.org instead
  • Or, a more extreme version of this would be to (somehow?) unify all project-specific end-user documentation under packaging.python.org

I'm not sure the last one is a good idea or even technically possible, but I do think giving end-users a one-stop-shop for user guides, tutorials, etc is something worth working towards.

(cc @brainwane @pradyunsg @ewdurbin @webknjaz @pfmoore @uranusjr @gaborbernat)

Guida per i contributori

Nessuna guida per i contributori indicizzata per questo repository

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Inizia esaminando i contenuti esistenti su packaging.python.org, pypa.io e nella documentazione di Warehouse, in particolare warehouse.pypa.io/api-reference/index.html. Mappa quali materiali sono rivolti agli utenti finali e quali ai contributor e maintainer di Warehouse, quindi documenta l’architettura delle informazioni proposta e l’ambito della migrazione. Questa issue sarà completata quando sarà stato concordato un piano per i confini tra i siti e la documentazione.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
python
Ambito
documentation
Tipo di issue
Documentazione
Difficoltà
5/5
Tempo stimato
Più di una settimana
Stato di attività
Ferma
Chiarezza
Da chiarire
Idoneità per principianti
25/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.