From 3bd21d061834469e8598d8cef807d325694b3b04 Mon Sep 17 00:00:00 2001 From: William Woodruff Date: Tue, 3 Dec 2024 10:16:50 -0500 Subject: [PATCH] docs: update API links everywhere Signed-off-by: William Woodruff --- docs/blog/posts/2023-05-24-pypi-was-subpoenaed.md | 2 +- docs/dev/application.rst | 7 +++---- docs/dev/security/index.rst | 4 ++-- docs/user/attestations/producing-attestations.md | 2 +- warehouse/api/README.md | 2 +- warehouse/templates/pages/help.html | 4 ++-- warehouse/templates/pages/security-key-giveaway.html | 2 +- warehouse/templates/pages/stats.html | 2 +- 8 files changed, 12 insertions(+), 13 deletions(-) diff --git a/docs/blog/posts/2023-05-24-pypi-was-subpoenaed.md b/docs/blog/posts/2023-05-24-pypi-was-subpoenaed.md index 56ea20351bcc..0d4e9bddd4fa 100644 --- a/docs/blog/posts/2023-05-24-pypi-was-subpoenaed.md +++ b/docs/blog/posts/2023-05-24-pypi-was-subpoenaed.md @@ -232,7 +232,7 @@ These were sourced from our database records and for past projects, are private PyPI does not retain download logs for packages which include IP addresses. Download logs are processed by a pipeline which includes GeoIP information reported by our CDN only. -These records were sourced from the [Google BigQuery Public dataset](https://warehouse.pypa.io/api-reference/bigquery-datasets.html) with the following queries: +These records were sourced from the [Google BigQuery Public dataset](https://docs.pypi.org/api/bigquery/) with the following queries: ```sql SELECT * FROM `bigquery-public-data.pypi.file_downloads` diff --git a/docs/dev/application.rst b/docs/dev/application.rst index e64eabd16d4a..16ef6def2575 100644 --- a/docs/dev/application.rst +++ b/docs/dev/application.rst @@ -110,7 +110,7 @@ Directories within the repository: - `organizations/ `_ - organization accounts - `packaging/ `_ - core packaging models (projects, releases, files) - `rate_limiting/ `_ - rate limiting to prevent abuse - - `rss/ `_ - RSS feeds: :doc:`api-reference/feeds` + - `rss/ `_ - `RSS Feeds `_ - `search/ `_ - utilities for building and querying the search index - `sitemap/ `_ - site maps - `sponsors/ `_ - sponsors management @@ -156,9 +156,8 @@ may be used to from the legacy site, such as: - `HTTP access to APIs; now it's HTTPS-only `_ -- GPG/PGP signatures for packages (still visible in the :doc:`../api-reference/legacy/` - per `PEP 503 `_, but no - longer visible in the web UI) +- GPG/PGP signatures for packages (no longer visible in the web UI or index, but retrievable + by appending an ``.asc`` if the signature exists) - `OpenID and Google auth login `_ are no longer supported. diff --git a/docs/dev/security/index.rst b/docs/dev/security/index.rst index 02000750b729..7ea54f23662f 100644 --- a/docs/dev/security/index.rst +++ b/docs/dev/security/index.rst @@ -18,6 +18,6 @@ directions for submitting security vulnerabilities, please visit Project and release activity details ------------------------------------ -See :doc:`/api-reference/feeds` for how to track new and updated releases on -PyPI. +See `RSS Feeds `_ for how to track new and +updated releases on PyPI. diff --git a/docs/user/attestations/producing-attestations.md b/docs/user/attestations/producing-attestations.md index e5207311a771..e6b7313c3f03 100644 --- a/docs/user/attestations/producing-attestations.md +++ b/docs/user/attestations/producing-attestations.md @@ -231,7 +231,7 @@ Before uploading attestations to the index, please: [twine]: https://github.com/pypa/twine -[legacy upload API documentation]: https://warehouse.pypa.io/api-reference/legacy.html#upload-api +[legacy upload API documentation]: /api/upload [GitLab Trusted Publishing]: /trusted-publishers/using-a-publisher/#gitlab-cicd [Linux Foundation Immutable Record notice]: https://lfprojects.org/policies/hosted-project-tools-immutable-records/ diff --git a/warehouse/api/README.md b/warehouse/api/README.md index 6e0adccdbff8..340d4d87d640 100644 --- a/warehouse/api/README.md +++ b/warehouse/api/README.md @@ -8,6 +8,6 @@ but do not live under the `/api/*` route namespace. They may be refactored to another location at some future point. We have API endpoints that pre-date the `/api/*` namespace, -see https://warehouse.pypa.io/api-reference/index.html for more. +see https://docs.pypi.org/api/ for more. All APIs under the `/api/*` namespace are JSON-only. diff --git a/warehouse/templates/pages/help.html b/warehouse/templates/pages/help.html index 05a7bb601082..b41a74a5935d 100644 --- a/warehouse/templates/pages/help.html +++ b/warehouse/templates/pages/help.html @@ -564,13 +564,13 @@

{{ trusted_publishers() }}

{% trans %}Integrating{% endtrans %}

{{ APIs() }}

-

{% trans %}Yes, including RSS feeds of new packages and new releases.{% endtrans %} {% trans %}See the API reference.{% endtrans %}

+

{% trans %}Yes, including RSS feeds of new packages and new releases.{% endtrans %} {% trans %}See the API reference.{% endtrans %}

{{ mirroring() }}

{% trans href='https://pypi.org/project/bandersnatch/' %}If you need to run your own mirror of PyPI, the bandersnatch project is the recommended solution. Note that the storage requirements for a PyPI mirror would exceed 1 terabyte—and growing!{% endtrans %}

{{ project_release_notifications() }}

-

{% trans href='https://github.com/marketplace?category=dependency-management&query=python', title=gettext('External link'), rss_href='https://warehouse.pypa.io/api-reference/feeds/#project-releases-feed' %}You can subscribe to the project releases RSS feed. Additionally, there are several third-party services that offer comprehensive monitoring and notifications for project releases and vulnerabilities listed as GitHub apps.{% endtrans %}

+

{% trans href='https://github.com/marketplace?category=dependency-management&query=python', title=gettext('External link'), rss_href='https://docs.pypi.org/api/feeds/#project-releases-feed' %}You can subscribe to the project releases RSS feed. Additionally, there are several third-party services that offer comprehensive monitoring and notifications for project releases and vulnerabilities listed as GitHub apps.{% endtrans %}

{{ statistics() }}

{% trans href='https://packaging.python.org/guides/analyzing-pypi-package-downloads/', title=gettext('External link') %}You can analyze PyPI project/package metadata and download usage statistics via our public dataset on Google BigQuery.{% endtrans %}

diff --git a/warehouse/templates/pages/security-key-giveaway.html b/warehouse/templates/pages/security-key-giveaway.html index ad0a01998711..be3f702210e3 100644 --- a/warehouse/templates/pages/security-key-giveaway.html +++ b/warehouse/templates/pages/security-key-giveaway.html @@ -58,7 +58,7 @@

What determines if a project is a critical project?

PyPI determines eligibility based on download counts derived from PyPI's public + href="https://docs.pypi.org/api/bigquery/">public dataset of download statistics. Any project in the top 1% of downloads over the prior 6 months is designated as critical.

diff --git a/warehouse/templates/pages/stats.html b/warehouse/templates/pages/stats.html index 3cdc269251c0..a9467ded78e6 100644 --- a/warehouse/templates/pages/stats.html +++ b/warehouse/templates/pages/stats.html @@ -33,7 +33,7 @@

{% trans %}First-party statistics{% endtrans %}