Skip to content

Merge on Monday: Remove beta warning from docs, add production availability expectations #3661

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

Merged
merged 7 commits into from
Apr 16, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
Warehouse
=========

Warehouse is a next-generation Python Package Repository designed to
replace the legacy code base that currently powers `PyPI`_
(whose source code `lives on GitHub`_). See `our development roadmap`_.
Warehouse is a next-generation Python Package Repository that powers
`PyPI`_ (whose source code `lives on GitHub`_). See `our development
roadmap`_.

You can find more information in the `documentation`_.

Expand All @@ -13,7 +13,7 @@ Getting Started
You can run Warehouse locally using ``docker`` and ``docker-compose``. See
`Getting started`_ in the documentation for instructions on how to set it up.

You can try a beta deployment of Warehouse at `pypi.org`_.
The canonical deployment of Warehouse is in production at `pypi.org`_.

Discussion
----------
Expand Down
41 changes: 14 additions & 27 deletions docs/api-reference/integration-guide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,29 +13,15 @@ recommendations
Migrating to the new PyPI
-------------------------

Warehouse is `currently in beta <http://pypi.org/help/#beta>`_. If
your site/service used to link or upload to pypi.python.org, you
should prepare to start using pypi.org instead.

If you have an automated tool that hits pypi.python.org less often
than once a second, and/or you are fine with small service
interruptions during the beta, then you should go ahead and start
using pypi.org now, and subscribe to `the PyPI announcement list
(low-traffic)
<https://mail.python.org/mm3/mailman3/lists/pypi-announce.python.org/>`_
for further announcements.

If you run a mission-critical automated production setup, or an
automated tool that hits pypi.python.org with 1+ requests/second, then
you should not explicitly point to pypi.org yet, but `you should test
and prepare to switch
<https://pyfound.blogspot.com/2018/03/warehouse-all-new-pypi-is-now-in-beta.html>`__. You
should also watch `our status page <http://status.python.org/>`__,
since we're occasionally redirecting portions of that traffic in load
tests that we announce on the status page. Subscribe to `the PyPI
announcement list (low-traffic)
Warehouse has now replaced `the legacy site pypi.python.org
<http://pypi.python.org/>`_. If your site/service used to link or
upload to pypi.python.org, it may continue to work due to redirects,
but you should use pypi.org instead.

You should also watch `our status page <http://status.python.org/>`__
and subscribe to `the PyPI announcement list (low-traffic)
<https://mail.python.org/mm3/mailman3/lists/pypi-announce.python.org/>`_
to find out when you should switch permanently.
to find out about future changes.

Here are some tips.

Expand Down Expand Up @@ -82,11 +68,12 @@ Here are some tips.
* Subscribe to `the PyPI announcement list (low-traffic)
<https://mail.python.org/mm3/mailman3/lists/pypi-announce.python.org/>`_.

* ``User-Agent`` Filtering: Some client user agents have been filtered to
always use ``pypi.python.org`` regardless of brownouts or redirects, in order
to give them extra time to migrate. Once ``pypi.python.org`` is shut down,
all clients will use ``pypi.org`` regardless of their ``User-Agent``. See
`the Warehouse Roadmap <https://wiki.python.org/psf/WarehouseRoadmap>` for a
* ``User-Agent`` Filtering: Some client user agents have been filtered
to always use ``pypi.python.org`` regardless of brownouts or
redirects, in order to give them extra time to migrate. Once
``pypi.python.org`` is shut down on 30 April, all clients will use
``pypi.org`` regardless of their ``User-Agent``. See `the Warehouse
Roadmap <https://wiki.python.org/psf/WarehouseRoadmap>`_ for a
timeline.

If you're a PyPI end user or packager looking to migrate to the new
Expand Down
13 changes: 6 additions & 7 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,9 @@ Contents:
ui-principles
security

Warehouse is a new code base that implements a `Python package index
(repository)`_. It is being `actively developed`_ and will eventually
power PyPI_ and replace an older code base that is currently powering
PyPI. You can see a beta version of Warehouse at https://pypi.org/
and you can read the `Warehouse roadmap`_.
Warehouse is a `web application`_ that implements the canonical
`Python package index (repository)`_; its production deployment is
PyPI_. It replaces an older code base that powered pypi.python.org.

The goal is to improve PyPI by making it:

Expand All @@ -26,6 +24,7 @@ The goal is to improve PyPI by making it:
- remove legacy APIs
- have more maintainable code with test coverage, docs, etc.

See the `Warehouse roadmap`_.


Indices and tables
Expand All @@ -36,6 +35,6 @@ Indices and tables
* :ref:`search`

.. _`Python package index (repository)`: https://packaging.python.org/glossary/#term-package-index
.. _`actively developed`: https://github.com/pypa/warehouse
.. _PyPI: https://pypi.python.org
.. _`web application`: https://github.com/pypa/warehouse
.. _PyPI: https://pypi.org
.. _`Warehouse roadmap`: https://wiki.python.org/psf/WarehouseRoadmap
5 changes: 4 additions & 1 deletion warehouse/templates/pages/help.html
Original file line number Diff line number Diff line change
Expand Up @@ -306,7 +306,10 @@ <h3 id="sponsors">{{ sponsors() }}</h3>

<h3 id="availability">{{ availability() }}</h3>
<p>
PyPI is heavily cached and distributed via CDN thanks to our sponsor <a href="https://www.fastly.com/" target="_blank" rel="noopener">Fastly</a> and thus is generally available globally. However, as could be expected for a giant distributed system, things can and sometimes do go wrong. If you have high availability requirements for your package index, consider either a <a href="#mirroring">mirror</a> or a <a href="#private-indices">private index</a>.
As of April 16, 2018, PyPI.org is at "production" status, meaning that it has moved out of beta and replaced the legacy site (pypi.python.org). It is now robust, tested, and ready for expected browser and API traffic.
</p>
<p>
PyPI is heavily cached and distributed via CDN thanks to our sponsor <a href="https://www.fastly.com/" target="_blank" rel="noopener">Fastly</a> and thus is generally available globally. However, the site is mostly maintained by volunteers, we do not provide any specific Service Level Agreement, and as could be expected for a giant distributed system, things can and sometimes do go wrong. Please see <a href="http://status.python.org/">our status page</a> for current and past outages and incidents. If you have high availability requirements for your package index, consider either a <a href="#mirroring">mirror</a> or a <a href="#private-indices">private index</a>.
</p>

<h3 id="contributing">{{ contributing() }}</h3>
Expand Down