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

Cover the PyPI migration in Tool Recommendations #335

Merged
merged 10 commits into from
Jun 24, 2017

Conversation

ncoghlan
Copy link
Member

@ncoghlan ncoghlan commented Jun 24, 2017

During the migration from the legacy PyPI implementation
to Warehouse, pypi.python.org and pypi.org are
essentially alternative tools for the tasks of publishing,
browsing, downloading and managing packages.

This adds them to the Tool Recommendations page, so
folks have a single place to check to be informed of the
current recommendations, rather than having to try to
keep up with any announcements made at the time the
recommendations change.

@ncoghlan ncoghlan force-pushed the ncoghlan-publishing-platform branch from d88f71e to 942ab09 Compare June 24, 2017 06:19
@ncoghlan
Copy link
Member Author

Heh, turns out my local clone of the PyPUG repo had got into a very messed up state. Had to delete and re-add all the remotes to fix it :)

@ncoghlan
Copy link
Member Author

@jonparrott I'm not clear on what's happening with the link checker here - it seems to be objecting to things that I didn't change.

@ncoghlan ncoghlan force-pushed the ncoghlan-publishing-platform branch from 942ab09 to f77b9db Compare June 24, 2017 06:28
@ncoghlan
Copy link
Member Author

@jonparrott Never mind, I figured it out - it helps to actually build the latest version of the docs before updating the link inventory :)

-------------------

* ``pypi.org`` became the default upload platform in September 2016
* uploads through ``pypi.python.org`` will be switched off on July 3, 2017
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This sentence looks wrong? Not entirely sure what this is supposed to be... "though" maybe?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh duh, it's a list not a paragraph, my brain is stupid.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I just switched all of them to normal paragraphs, but this made me realise that means I also need to add a bunch of full stops :)

* ``setuptools`` 27.0.0
* Python 3.4.6 (``distutils`` update)
* Python 3.5.3 (``distutils`` update)
* Python 3.6.0 (``distutils`` update)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There's a 2.7 change too, but the GitHub UI wasn't working to show me the tag and I don't have my CPython clone handy atm.

Copy link
Member Author

@ncoghlan ncoghlan Jun 24, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Checking distutils.core in the 2.7 branch shows you changed it in August, so it would have been first included in 2.7.13 in December (which I've now added to the PR).

some users may choose to opt in to using it
* ``pypi.org`` is expected to become the default recommended interface for browsing
once the limitations in the next two sections are addressed (at which point
``pypi.python.org`` is also expected to become a CNAME for ``pypi.org``)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Small nit, it probably won't be a CNAME, but a redirect so we push the link juice over to the new domain.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I reworded this to just be suitably vague about the exact mechanism

ncoghlan added 7 commits June 24, 2017 16:46
- change heading ("Recommendations" -> "Migration")
- use ordinary paragraphs instead of bullet points
- emphasise the legacy PyPI upload shutdown date
- fix assorted markup problems
- rewrap
The reason this page was renamed is because the "projects"
namespace is actually reserved on RTD for subprojects of a
parent project.

Since that means it doesn't work properly as a redirect
either, don't worry about trying to preserve those deeplinks.
@ncoghlan
Copy link
Member Author

@jonparrott In going to add the "projects" redirect to ReadTheDocs, I remembered why I changed the name of that page in the first place (it collides with RTD's subproject feature). So I ended up just clearing those old links out of the link inventory, rather than registering a suitable redirect.

@ncoghlan ncoghlan merged commit cc80122 into pypa:master Jun 24, 2017
@ncoghlan
Copy link
Member Author

Thanks for the reviews folks - I went ahead and merged this so the destination link will become valid, and we can tweak it in the future as we see fit.

@theacodes
Copy link
Member

@ncoghlan that's fine.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants