Skip to content

Commit

Permalink
chore: update URLs (#12007)
Browse files Browse the repository at this point in the history
* chore: rename pypa/warehouse to pypi/warehouse

Once the repo was moved to `pypi` org, saves a redirect on every lookup.

Signed-off-by: Mike Fiedler <[email protected]>

* chore: update default branch to `main`

Signed-off-by: Mike Fiedler <[email protected]>

* chore: inform sphinx to ignore local links

When running `make linkcheck`, ignore any links that won't work.

Signed-off-by: Mike Fiedler <[email protected]>

* chore: fix broken links

As identified with `make linkcheck`.

Signed-off-by: Mike Fiedler <[email protected]>

* chore: update warehouse readthedocs url

Signed-off-by: Mike Fiedler <[email protected]>

* chore: convert to sphinx references

Signed-off-by: Mike Fiedler <[email protected]>

* lint: docs line too long

Signed-off-by: Mike Fiedler <[email protected]>

* chore: update test urls

to match the migrated repo
  • Loading branch information
miketheman authored Aug 8, 2022
1 parent d401b70 commit c95be4a
Show file tree
Hide file tree
Showing 35 changed files with 169 additions and 165 deletions.
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
blank_issues_enabled: false
contact_links:
- name: "(Maintainers Only) Blank issue"
url: https://github.com/pypa/warehouse/issues/new
url: https://github.com/pypi/warehouse/issues/new
about: For maintainers only.
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/~good-first-issue.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ about: For maintainers to create an issue that is good for new contributors
<!-- End issue text, leave the following intact -->
---

**Good First Issue**: This issue is good for first time contributors. If you've already contributed to Warehouse, work on [another issue without this label](https://github.com/pypa/warehouse/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aopen+-label%3A%22good+first+issue%22) instead. If there is not a corresponding pull request for this issue, it is up for grabs. For directions for getting set up, see our [Getting Started Guide](https://warehouse.pypa.io/development/getting-started/).
**Good First Issue**: This issue is good for first time contributors. If you've already contributed to Warehouse, work on [another issue without this label](https://github.com/pypi/warehouse/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aopen+-label%3A%22good+first+issue%22) instead. If there is not a corresponding pull request for this issue, it is up for grabs. For directions for getting set up, see our [Getting Started Guide](https://warehouse.pypa.io/development/getting-started/).

If you are working on this issue and have questions, feel free to ask them here, in the [`#pypa-dev` chat channel on Libera](https://web.libera.chat/#pypa-dev), the [PyPA Discord](https://discord.gg/pypa) or on the [Discourse](https://discuss.python.org/c/packaging/14).

Expand Down
2 changes: 1 addition & 1 deletion CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,4 @@ Examples of contributions include:

Extensive contribution guidelines are available in the repository at
``docs/development/index.rst`` or
`online <https://warehouse.readthedocs.io/development/>`_.
`online <https://warehouse.pypa.io/development/>`_.
14 changes: 7 additions & 7 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -48,15 +48,15 @@ Everyone interacting in the Warehouse project's codebases, issue trackers, chat
rooms, and mailing lists is expected to follow the `PSF Code of Conduct`_.

.. _`PyPI`: https://pypi.org/
.. _`our development roadmap`: https://warehouse.readthedocs.io/roadmap/
.. _`architectural overview`: https://warehouse.readthedocs.io/application/
.. _`documentation`: https://warehouse.readthedocs.io
.. _`Getting started`: https://warehouse.readthedocs.io/development/getting-started/
.. _`Github issue tracker`: https://github.com/pypa/warehouse/issues
.. _`our development roadmap`: https://warehouse.pypa.io/roadmap/
.. _`architectural overview`: https://warehouse.pypa.io/application/
.. _`documentation`: https://warehouse.pypa.io
.. _`Getting started`: https://warehouse.pypa.io/development/getting-started/
.. _`Github issue tracker`: https://github.com/pypi/warehouse/issues
.. _`pypi.org`: https://pypi.org/
.. _`Running tests and linters section`: https://warehouse.readthedocs.io/development/getting-started/#running-tests-and-linters
.. _`Running tests and linters section`: https://warehouse.pypa.io/development/getting-started/#running-tests-and-linters
.. _BrowserStack: https://browserstack.com/
.. _`supported browsers`: https://warehouse.readthedocs.io/development/frontend/#browser-support
.. _`supported browsers`: https://warehouse.pypa.io/development/frontend/#browser-support
.. |BrowserStackImg| image:: docs/_static/browserstack-logo.png
.. _BrowserStackImg: https://browserstack.com/
.. _`PSF Code of Conduct`: https://github.com/pypa/.github/blob/main/CODE_OF_CONDUCT.md
Expand Down
13 changes: 6 additions & 7 deletions docs/api-reference/integration-guide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ to redirects, but you should use pypi.org instead.

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

Here are some tips.
Expand Down Expand Up @@ -58,12 +58,12 @@ Here are some tips.
``https://pypi.org/rss/packages.xml``. See :doc:`feeds` for
descriptions. `The data differs from the legacy feed data because
the new feeds are standards-compliant and fix inaccuracies in the
publication date <https://github.com/pypa/warehouse/issues/3238>`_.
publication date <https://github.com/pypi/warehouse/issues/3238>`_.

* Documentation upload: Users can no longer use ``doc_upload`` in the
API to upload documentation ZIP files, separate from packages, to be
hosted at pythonhosted.org (`discussion
<https://github.com/pypa/warehouse/issues/509>`_).
<https://github.com/pypi/warehouse/issues/509>`_).

* ``User-Agent`` Filtering: Some client user agents were filtered to
always use ``legacy.pypi.org``, a temporary deployment of the legacy
Expand All @@ -73,7 +73,7 @@ Here are some tips.
regardless of their ``User-Agent``.

* Subscribe to `the PyPI announcement list (low-traffic)
<https://mail.python.org/mm3/mailman3/lists/pypi-announce.python.org/>`_.
<https://mail.python.org/mailman3/lists/pypi-announce.python.org/>`_.

If you're a PyPI end user or packager looking to migrate to the new
PyPI, see `the official Python Packaging User Guide on migrating to PyPI
Expand All @@ -93,7 +93,7 @@ Official guidance
-----------------

Query PyPI’s `JSON
API <https://warehouse.readthedocs.io/api-reference/json/>`__ to
API <https://warehouse.pypa.io/api-reference/json/>`__ to
determine where to download files from.

If you so choose
Expand Down Expand Up @@ -126,5 +126,4 @@ where ``project_l`` is the first letter of the project name.
structure PyPI used to hold on disk. In general this is only a good idea
for ``source`` as a ``python_version`` to fetch tar and zip files.
Otherwise, you will want to match the format of the ``python_version``
field of the releases in the `JSON
API <https://warehouse.readthedocs.io/api-reference/json/>`__.
field of the releases in the :doc:`json`.
2 changes: 1 addition & 1 deletion docs/api-reference/json.rst
Original file line number Diff line number Diff line change
Expand Up @@ -291,7 +291,7 @@ Known vulnerabilities
~~~~~~~~~~~~~~~~~~~~~

In the example above, the combination of the requested project and version
had no `known vulnerabilities <https://github.com/pypa/advisory-db>`_.
had no `known vulnerabilities <https://github.com/pypa/advisory-database>`_.
An example of a response for a project with known vulnerabilities is
provided below, with unrelated fields collapsed for readability.

Expand Down
2 changes: 1 addition & 1 deletion docs/api-reference/legacy.rst
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ The Simple API implements the HTML-based package index API as specified in `PEP


.. _`pypi-legacy`: https://pypi.python.org/
.. _`PEP 503`: https://www.python.org/dev/peps/pep-0503/
.. _`PEP 503`: https://peps.python.org/pep-0503/

.. _upload-api-forklift:

Expand Down
2 changes: 1 addition & 1 deletion docs/api-reference/xml-rpc.rst
Original file line number Diff line number Diff line change
Expand Up @@ -203,4 +203,4 @@ Mirroring Support
Retrieve a dictionary mapping package names to the last serial for each
package.

.. _pypi-announce: https://mail.python.org/mm3/mailman3/lists/pypi-announce.python.org/
.. _pypi-announce: https://mail.python.org/mailman3/lists/pypi-announce.python.org/
76 changes: 38 additions & 38 deletions docs/application.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,15 @@ Warehouse uses the
`Pyramid`_ web framework, the
`SQLAlchemy <https://docs.sqlalchemy.org/en/latest/>`__ ORM, and
`Postgres <https://www.postgresql.org/docs/>`__ for its database.
Warehouse's front end uses `Jinja2 <http://jinja.pocoo.org/>`__ templates.
Warehouse's front end uses `Jinja2 <https://jinja.palletsprojects.com/>`__ templates.

The production deployment for Warehouse is deployed using
`Cabotage <https://github.com/cabotage/cabotage-app>`__, which manages
`Docker`_ containers deployed via `Kubernetes <https://kubernetes.io>`__.

In the development environment, we use several `Docker`_ containers
orchestrated by `Docker Compose <https://docs.docker.com/compose/overview/>`__
to `manage <https://github.com/pypa/warehouse/blob/master/docker-compose.yml#L3>`__
to `manage <https://github.com/pypi/warehouse/blob/main/docker-compose.yml#L3>`__
running the containers and the connections between them.

Since Warehouse was built on top of an existing database (for legacy
Expand Down Expand Up @@ -84,39 +84,39 @@ The top-level directory of the Warehouse repo contains files including:

Directories within the repository:

- `bin/ <https://github.com/pypa/warehouse/tree/master/bin>`_ - high-level scripts for Docker, Continuous Integration, and Makefile commands
- `dev/ <https://github.com/pypa/warehouse/tree/master/dev>`_ - assets for developer environment
- `tests/ <https://github.com/pypa/warehouse/tree/master/tests>`_ - tests
- `warehouse/ <https://github.com/pypa/warehouse/tree/master/warehouse>`_ - code in modules

- `accounts/ <https://github.com/pypa/warehouse/tree/master/warehouse/accounts>`_ - user accounts
- `admin/ <https://github.com/pypa/warehouse/tree/master/warehouse/admin>`_ - application-administrator-specific
- `banners/ <https://github.com/pypa/warehouse/tree/master/warehouse/banners>`_ - notification banners
- `cache/ <https://github.com/pypa/warehouse/tree/master/warehouse/cache>`_ - caching
- `classifiers/ <https://github.com/pypa/warehouse/tree/master/warehouse/classifiers>`_ - frame trove classifiers
- `cli/ <https://github.com/pypa/warehouse/tree/master/warehouse/cli>`_ - entry scripts and
`the interactive shell <https://warehouse.readthedocs.io/development/getting-started/#running-the-interactive-shell>`_
- `email/ <https://github.com/pypa/warehouse/tree/master/warehouse/email>`_ - services for sending emails
- `forklift/ <https://github.com/pypa/warehouse/tree/master/warehouse/forklift>`_ - :ref:`upload-api-forklift`
- `i18n/ <https://github.com/pypa/warehouse/tree/master/warehouse/i18n>`_ - internationalization
- `integrations/ <https://github.com/pypa/warehouse/tree/master/warehouse/integrations>`_ - integrations with other services
- `legacy/ <https://github.com/pypa/warehouse/tree/master/warehouse/legacy>`_ - most of the read-only APIs implemented here
- `locale/ <https://github.com/pypa/warehouse/tree/master/warehouse/locale>`_ - internationalization
- `macaroons/ <https://github.com/pypa/warehouse/tree/master/warehouse/macaroons>`_ - API token support
- `malware/ <https://github.com/pypa/warehouse/tree/master/warehouse/malware>`_ - automated malware checks
- `manage/ <https://github.com/pypa/warehouse/tree/master/warehouse/manage>`_ - logged-in user functionality (i.e., manage account &
- `bin/ <https://github.com/pypi/warehouse/tree/main/bin>`_ - high-level scripts for Docker, Continuous Integration, and Makefile commands
- `dev/ <https://github.com/pypi/warehouse/tree/main/dev>`_ - assets for developer environment
- `tests/ <https://github.com/pypi/warehouse/tree/main/tests>`_ - tests
- `warehouse/ <https://github.com/pypi/warehouse/tree/main/warehouse>`_ - code in modules

- `accounts/ <https://github.com/pypi/warehouse/tree/main/warehouse/accounts>`_ - user accounts
- `admin/ <https://github.com/pypi/warehouse/tree/main/warehouse/admin>`_ - application-administrator-specific
- `banners/ <https://github.com/pypi/warehouse/tree/main/warehouse/banners>`_ - notification banners
- `cache/ <https://github.com/pypi/warehouse/tree/main/warehouse/cache>`_ - caching
- `classifiers/ <https://github.com/pypi/warehouse/tree/main/warehouse/classifiers>`_ - frame trove classifiers
- `cli/ <https://github.com/pypi/warehouse/tree/main/warehouse/cli>`_ - entry scripts and
:ref:`the interactive shell <running-the-interactive-shell>`
- `email/ <https://github.com/pypi/warehouse/tree/main/warehouse/email>`_ - services for sending emails
- `forklift/ <https://github.com/pypi/warehouse/tree/main/warehouse/forklift>`_ - :ref:`upload-api-forklift`
- `i18n/ <https://github.com/pypi/warehouse/tree/main/warehouse/i18n>`_ - internationalization
- `integrations/ <https://github.com/pypi/warehouse/tree/main/warehouse/integrations>`_ - integrations with other services
- `legacy/ <https://github.com/pypi/warehouse/tree/main/warehouse/legacy>`_ - most of the read-only APIs implemented here
- `locale/ <https://github.com/pypi/warehouse/tree/main/warehouse/locale>`_ - internationalization
- `macaroons/ <https://github.com/pypi/warehouse/tree/main/warehouse/macaroons>`_ - API token support
- `malware/ <https://github.com/pypi/warehouse/tree/main/warehouse/malware>`_ - automated malware checks
- `manage/ <https://github.com/pypi/warehouse/tree/main/warehouse/manage>`_ - logged-in user functionality (i.e., manage account &
owned/maintained projects)
- `metrics/ <https://github.com/pypa/warehouse/tree/master/warehouse/metrics>`_ - services for recording metrics
- `migrations/ <https://github.com/pypa/warehouse/tree/master/warehouse/migrations>`_ - changes to the database schema
- `packaging/ <https://github.com/pypa/warehouse/tree/master/warehouse/packaging>`_ - models
- `rate_limiting/ <https://github.com/pypa/warehouse/tree/master/warehouse/rate_limiting>`_ - rate limiting to prevent abuse
- `rss/ <https://github.com/pypa/warehouse/tree/master/warehouse/rss>`_ - RSS feeds: :doc:`api-reference/feeds`
- `search/ <https://github.com/pypa/warehouse/tree/master/warehouse/search>`_ - utilities for building and querying the search index
- `sitemap/ <https://github.com/pypa/warehouse/tree/master/warehouse/sitemap>`_ - site maps
- `sponsors/ <https://github.com/pypa/warehouse/tree/master/warehouse/sponsors>`_ - sponsors management
- `static/ <https://github.com/pypa/warehouse/tree/master/warehouse/static>`_ - static site assets
- `templates/ <https://github.com/pypa/warehouse/tree/master/warehouse/templates>`_ - Jinja templates for web pages, emails, etc.
- `utils/ <https://github.com/pypa/warehouse/tree/master/warehouse/utils>`_ - various utilities Warehouse uses
- `metrics/ <https://github.com/pypi/warehouse/tree/main/warehouse/metrics>`_ - services for recording metrics
- `migrations/ <https://github.com/pypi/warehouse/tree/main/warehouse/migrations>`_ - changes to the database schema
- `packaging/ <https://github.com/pypi/warehouse/tree/main/warehouse/packaging>`_ - models
- `rate_limiting/ <https://github.com/pypi/warehouse/tree/main/warehouse/rate_limiting>`_ - rate limiting to prevent abuse
- `rss/ <https://github.com/pypi/warehouse/tree/main/warehouse/rss>`_ - RSS feeds: :doc:`api-reference/feeds`
- `search/ <https://github.com/pypi/warehouse/tree/main/warehouse/search>`_ - utilities for building and querying the search index
- `sitemap/ <https://github.com/pypi/warehouse/tree/main/warehouse/sitemap>`_ - site maps
- `sponsors/ <https://github.com/pypi/warehouse/tree/main/warehouse/sponsors>`_ - sponsors management
- `static/ <https://github.com/pypi/warehouse/tree/main/warehouse/static>`_ - static site assets
- `templates/ <https://github.com/pypi/warehouse/tree/main/warehouse/templates>`_ - Jinja templates for web pages, emails, etc.
- `utils/ <https://github.com/pypi/warehouse/tree/main/warehouse/utils>`_ - various utilities Warehouse uses

.. _Pyramid: https://docs.pylonsproject.org/projects/pyramid/en/latest/index.html
.. _Docker: https://docs.docker.com/
Expand All @@ -137,16 +137,16 @@ may be used to from the legacy site, such as:
- "hidden releases"

- uploading to pythonhosted.com documentation hosting (`discussion and
plans <https://github.com/pypa/warehouse/issues/582>`_)
plans <https://github.com/pypi/warehouse/issues/582>`_)

- `download counts visible in the API <https://warehouse.readthedocs.io/api-reference/xml-rpc/#changes-to-legacy-api>`_
- :ref:`download counts visible in the API <changes-to-legacy-api>`
(instead, use `the Google BigQuery service <https://packaging.python.org/guides/analyzing-pypi-package-downloads/>`_)

- key management: PyPI no longer has a UI for users to manage GPG or
SSH public keys

- uploading new releases via the web UI: instead, maintainers should
use the command-line tool `Twine <http://twine.readthedocs.io/>`_
use the command-line tool `Twine <https://twine.readthedocs.io/>`_

- updating release descriptions via the web UI: instead, to update
release metadata, you need to upload a new release (`discussion
Expand All @@ -157,7 +157,7 @@ may be used to from the legacy site, such as:
- `HTTP access to APIs; now it's HTTPS-only <https://mail.python.org/pipermail/distutils-sig/2017-October/031712.html>`_

- GPG/PGP signatures for packages (still visible in the :doc:`../api-reference/legacy/`
per `PEP 503 <https://www.python.org/dev/peps/pep-0503/>`_, but no
per `PEP 503 <https://peps.python.org/pep-0503/>`_, but no
longer visible in the web UI)

- `OpenID and Google auth login <https://mail.python.org/pipermail/distutils-sig/2018-January/031855.html>`_
Expand Down
7 changes: 7 additions & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,13 @@
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = "sphinx"

# Patterns to during `make linkcheck`
linkcheck_ignore = [
r'http://localhost.*',
'http://134.122.111.11', # example IP
'https://web.libera.chat/#pypa,#pypa-dev', # can't visit anchors
]


# -- Options for HTML output ----------------------------------------------

Expand Down
4 changes: 2 additions & 2 deletions docs/development/frontend.rst
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ JavaScript tests use the `Jest testing framework <https://jestjs.io/>`_
along with `jest-dom <https://github.com/testing-library/jest-dom>`_
for assertion helpers. We can invoke Jest directly specify a particular
test suite via ``node_modules/.bin/jest tests/frontend/<TEST_FILE>.js`` or
add any of the `Jest CLI options <https://jestjs.io/docs/en/cli>`_ .
add any of the `Jest CLI options <https://jestjs.io/docs/cli>`_ .
All tests are located in the ``tests/frontend``.

`Stimulus <https://stimulusjs.org/>`_ controller tests leverage on Jest
Expand Down Expand Up @@ -98,7 +98,7 @@ Exceptions to these rules include:

We also allow both dashes and underscores in our class names, as we
follow the `Nicholas Gallagher variation
<http://nicolasgallagher.com/about-html-semantics-front-end-architecture/>`_
<https://nicolasgallagher.com/about-html-semantics-front-end-architecture/>`_
of the `BEM naming methodology <https://en.bem.info/>`_.

More information on how BEM works can be found in `this article from
Expand Down
Loading

0 comments on commit c95be4a

Please sign in to comment.