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

Migrating interoperability specifications to PyPUG #11

Open
ncoghlan opened this Issue Jan 19, 2016 · 11 comments

Comments

Projects
None yet
2 participants
@ncoghlan
Member

ncoghlan commented Jan 19, 2016

I have some time at the moment to work on upstream process improvement, and one of the things I'd like to tidy up is the change management process for interoperability specifications. Some relevant previous discussions:

Since that last discussion, @dstufft, @nlhkabu and @ddbeck have done a lot more design work on Warehouse and the user guide, so I've now come around to the view that the PyPA internal docs are likely to be a better home.

Rather than using PEP 440 or PEP 508 as guinea pigs, I'm thinking a better starting point might be PEP 376 (the database of installed Python distributions), since we can tweak the description on pypa.io to specifically cover the interoperability spec parts that pip implements, and omit the standard library API parts.

I'll put together a pull request along those lines, adding a new "PyPA Specifications" section, with process details (based on the first email linked above), and a section on the RECORD file and the directory naming scheme.

@ncoghlan

This comment has been minimized.

Member

ncoghlan commented Jan 19, 2016

(I don't currently have access to assign this to myself, so if I could be added, that would be great)

@dstufft

This comment has been minimized.

Member

dstufft commented Jan 19, 2016

Just to be clear, you want to move the PEPs out of the PEP repository and into uh, this one I guess? Or what specifically is the plan?

@ncoghlan

This comment has been minimized.

Member

ncoghlan commented Jan 19, 2016

Not quite. What I'd like to do is shift to a model closer to the way
CPython uses the PEP process:

  • the interoperability specifications that people actually use to write
    software live in this repo (and are referenced by stable URLs)
  • the PEP process is used to manage changes to the specifications, but
    the spec updates themselves would be implemented as PRs against this repo.

That way, if you just want the current spec, that's always readily
available, and you only need to look at the PEPs to understand why the
spec is the way it is.

@dstufft

This comment has been minimized.

Member

dstufft commented Jan 19, 2016

Okay, great. I've added the PEP Authors team as committers to this repository then.

@ncoghlan ncoghlan self-assigned this Jan 19, 2016

@ncoghlan

This comment has been minimized.

Member

ncoghlan commented Jan 21, 2016

Initial PR: #12

(I'm also working on an update to the roadmap to point to this issue from the relevant sections)

@ncoghlan

This comment has been minimized.

Member

ncoghlan commented Jan 22, 2016

distutils-sig thread: https://mail.python.org/pipermail/distutils-sig/2016-January/028060.html

After reflecting on the PR and likely future workflows, I've switched to favouring a split approach where we put the process definition here (since it's really only relevant to PyPA & distutils-sig members), but have the specifications themselves on packaging.python.org.

The main purposes of that is to keep the packaging specifications on the same standing as the Language Reference and Library Reference in terms of "brand recognition" for their top level domain.

@ncoghlan

This comment has been minimized.

Member

ncoghlan commented Jan 25, 2016

I implemented the split where the process guide is here, but the specifications themselves stay on *.python.org:

Process PR: #14
Specifications PR: pypa/python-packaging-user-guide#213

@ncoghlan ncoghlan changed the title from Migrating interoperability specifications to pypa.io to Migrating interoperability specifications to PyPUG Jan 25, 2016

@ncoghlan

This comment has been minimized.

Member

ncoghlan commented Mar 11, 2016

Next steps:

  • update for the migration of the main PEPs repo to GitHub
  • update the process description to allow errata & minor amendments to be handled as PyPUG issues and pull requests, rather than full PEPs
  • update the PEPs themselves with links pointing to the appropriate section in https://packaging.python.org/en/latest/specifications/ for errata & amendments
@ncoghlan

This comment has been minimized.

Member

ncoghlan commented Aug 1, 2016

Added an extra task bullet to account for the migration of https://github.com/python/peps to GitHub

@ncoghlan

This comment has been minimized.

Member

ncoghlan commented Feb 6, 2017

#19 implements the first 2 bullet points in the task list

@ncoghlan

This comment has been minimized.

Member

ncoghlan commented Oct 3, 2017

@di split the specifications page up into multiple pages, and migrated the full core metadata description over to packaging.python.org in pypa/python-packaging-user-guide#386

@ncoghlan ncoghlan referenced this issue Dec 4, 2017

Closed

Metadata 1.3 PEP #1

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment