docs: migrate index/upload API docs to user docs #17123
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: William Woodruff <[email protected]>
Signed-off-by: William Woodruff <[email protected]>
Signed-off-by: William Woodruff <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This moves the "legacy" API docs into two new user-docs pages:
Combined, these two new docs have almost exactly the same contents as the old
legacy.rst, but with a few cleanups and cross-links to things like the Integrity API.I've also used the phrase "Index API" instead of "legacy API," since the former appears to cause confusion among users (they think it means the API is deprecated, when really it means it was migrated from the "legacy" PyPI). I'm happy to change that back, though!
I've left
legacy.rstas a stub page with some links so that people can follow to the new docs, but I think another option here would be to remove it entirely and let search engines reindex on the new pages.See #16541.