warehouse icon indicating copy to clipboard operation
warehouse copied to clipboard

base: replace PEP 541 link with user documentation link

Open woodruffw opened this issue 7 months ago • 1 comments

To keep things balanced between the different columns, I've removed the link to PEP 541 and replaced it with a link to the user docs.

This has the downside of removing a link to the index's name retention polcies. However, I think there are two possible resolutions here:

  1. Add the retention policies within the user docs (i.e. by copying them from the PEP and adding a "living" banner to the PEP, similar to other packaging PEPs)
  2. Add the retention policies to https://policies.python.org (under the PyPI group) instead, since they're conceptually related to the other policies (AUP, T&C).

Curious what others think about either of the above 🙂

Closes #17959.

woodruffw avatar Apr 21 '25 19:04 woodruffw

I'm generally in favor of moving away from calling things a "PEP 541 request" and codifying it in a Policy, thus allowing further evolution of the policy and departing from the PEP number.

Sounds good! In that case what I'll do is copy the policy bits of PEP 541 into a new PR against policies.python.org, which will then be a blocker before landing this 🙂

Not to increase scope too heavily, but that effort should be paired with updates to pypi/support tracker and other places where the policy is mentioned.

I can do a survey of these points.

woodruffw avatar Apr 22 '25 15:04 woodruffw

(Just responding to say I haven't forgotten about this. I'll probably do it at PyCon!)

woodruffw avatar May 09 '25 18:05 woodruffw

Revisiting this -- I think this is the stack of requirements for unblocking this:

  • [ ] policies.python.org needs a new PyPI-specific "name retention policy" page that reflects the policy specified in PEP 541: https://github.com/psf/policies/pull/41
  • [ ] PEP 541 needs to be updated to link to the above with the "historical reference" banner
  • [ ] pypi/support needs changes to its pep541-request.yml issue template to have it reference the above policy instead of referencing a PEP by number
  • [ ] This PR needs to be updated to reference policies.python.org where appropriate rather than PEP 541

@miketheman do you think I'm missing anything above? 🙂

woodruffw avatar Jun 03 '25 17:06 woodruffw

I think that's correct - although we're probably missing a bunch of references somewhere. Maybe an update to the PEP page that states "this page is a historical reference..." kind of thing?

miketheman avatar Jun 04 '25 20:06 miketheman

xref: I've done the first part of above with https://github.com/psf/policies/pull/41

woodruffw avatar Jun 18 '25 18:06 woodruffw