From 9c2ba77db106ed356c96b0c80445fe15f24cfca1 Mon Sep 17 00:00:00 2001
From: William Woodruff <william@trailofbits.com>
Date: Mon, 25 Nov 2024 14:38:57 -0500
Subject: [PATCH] docs: migrate RSS Feed docs to user docs

Signed-off-by: William Woodruff <william@trailofbits.com>
---
 docs/dev/api-reference/feeds.rst | 68 ++------------------------------
 docs/mkdocs-user-docs.yml        |  1 +
 docs/user/api/feeds.md           | 27 +++++++++++++
 3 files changed, 32 insertions(+), 64 deletions(-)
 create mode 100644 docs/user/api/feeds.md

diff --git a/docs/dev/api-reference/feeds.rst b/docs/dev/api-reference/feeds.rst
index 2f17102971b3..cd9e398d6d0a 100644
--- a/docs/dev/api-reference/feeds.rst
+++ b/docs/dev/api-reference/feeds.rst
@@ -1,69 +1,9 @@
 Feeds
 =====
 
-PyPI offers three RSS feeds, the `Newest Packages Feed`_, the `Latest Updates
-Feed`_, and the `Project Releases Feed`_. You can also call its APIs to get
-more details on project activity.
+.. important::
 
+  This API documentation has been migrated to a new page in
+  the `user documentation <https://docs.pypi.org/>`_:
 
-Newest Packages Feed
---------------------
-
-Available at https://pypi.org/rss/packages.xml, this feed provides the latest
-newly created projects on PyPI, including the package name, description and a
-link to the project page.
-
-
-Latest Updates Feed
--------------------
-
-Available at https://pypi.org/rss/updates.xml, this feed provides the latest
-newly created releases for individual projects on PyPI, including the project
-name and description, release version, and a link to the release page.
-
-
-Project Releases Feed
----------------------
-
-Available at ``https://pypi.org/rss/project/<project_name>/releases.xml`` for each
-project, this feed provides the latest releases for the given project on
-PyPI, including the package name and description, release version, and a link
-to the release page.
-
-
-Project and release activity details
-------------------------------------
-
-PyPI publishes a "journal" of all project, package, and release
-activity (including Owner and Maintainer additions and removals, and
-source file and release additions and removals). You can query it with
-a mix of :ref:`changelog-since` and the
-`index API <https://docs.pypi.org/api/index-api/>`_. Call
-``changelog_last_serial()`` (in :doc:`xml-rpc`) to get the current
-revision of the journal (the last event's serial ID), then look at
-``/simple/`` to get a list of all packages that currently
-exist. Subsequently, you can call
-``changelog_since_serial(since_serial)`` with the serial ID you
-retrieved, and get the list of all actions that have occurred since
-then.
-
-Example usage::
-
-  >>> import time
-  >>> import xmlrpc.client
-  >>> client = xmlrpc.client.ServerProxy("https://test.pypi.org/pypi")
-  >>> serial = client.changelog_last_serial()
-  >>> serial
-  4601224
-  >>> while serial == client.changelog_last_serial():
-  ...     time.sleep(5)
-  >>> recentchanges = client.changelog_since_serial(serial)
-  >>> for entry in recentchanges:
-  ...     print(entry)
-  ['openllm', '0.4.33.dev3', 1701280908, 'new release', 4601225]
-  ['openllm', '0.4.33.dev3', 1701280908, 'add py3 file openllm-0.4.33.dev3-py3-none-any.whl', 4601226]
-
-You could also request ``GET /simple/``, and record the ``ETag``, and
-then periodically do a conditional HTTP GET to ``/simple/`` with that
-ETag included. A 200 OK response indicates something has been added or
-removed; if you get a 304 Not Modified, then nothing has changed.
+  * `RSS Feeds <https://docs.pypi.org/api/feeds/>`_
diff --git a/docs/mkdocs-user-docs.yml b/docs/mkdocs-user-docs.yml
index bb8259f64e5a..bd4e3d6e7a46 100644
--- a/docs/mkdocs-user-docs.yml
+++ b/docs/mkdocs-user-docs.yml
@@ -93,3 +93,4 @@ nav:
       - "api/integrity.md"
       - "api/stats.md"
       - "api/bigquery.md"
+      - "api/feeds.md"
diff --git a/docs/user/api/feeds.md b/docs/user/api/feeds.md
new file mode 100644
index 000000000000..bb3bbfa9de16
--- /dev/null
+++ b/docs/user/api/feeds.md
@@ -0,0 +1,27 @@
+# RSS Feeds
+
+PyPI offers three RSS feeds: the Newest Packages Feed, the Latest Updates
+Feed, and the Project Releases Feed.
+
+## Newest Packages Feed
+
+*Feed URL:* <https://pypi.org/rss/packages.xml>
+
+This feed provides the latest newly created projects on PyPI, including the
+package name, description and a link to the project page.
+
+## Latest Updates Feed
+
+*Feed URL:* <https://pypi.org/rss/updates.xml>
+
+This feed provides the latest newly created releases for individual projects on
+PyPI, including the project name and description, release version, and a link
+to the release page.
+
+## Project Releases Feed
+
+*Feed URL:* `https://pypi.org/rss/project/<project_name>/releases.xml`
+
+Available for each project, this feed provides the latest releases for the
+given project on PyPI, including the package name and description, release
+version, and a link to the release page.