-
Notifications
You must be signed in to change notification settings - Fork 996
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
docs: new and shiny storage limit docs #17716
Merged
Merged
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]>
woodruffw
commented
Mar 5, 2025
@@ -5,6 +5,8 @@ WAREHOUSE_ENV=development | |||
WAREHOUSE_TOKEN=insecuretoken | |||
WAREHOUSE_IP_SALT="insecure himalayan pink salt" | |||
|
|||
USERDOCS_DOMAIN="http://localhost:10000" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
NB: This ensures that local deployments link to the local user docs build, rather than docs.pypi.org
(which is otherwise the default).
Signed-off-by: William Woodruff <[email protected]>
di
reviewed
Mar 7, 2025
di
reviewed
Mar 7, 2025
Signed-off-by: William Woodruff <[email protected]>
@woodruffw FYI, you need to rebuild translations here. |
Signed-off-by: William Woodruff <[email protected]>
Done! |
di
approved these changes
Mar 11, 2025
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 is my attempt to scaffold out a clean segue from the existing
help.html
to the newermkdocs
-managed user documentation, using #17702 as a testcase.Key changes:
request.user_docs_url
request method that makes it easy to route to user documentation pages, including specific anchors./project-management/storage-limits/
with most of the file/project storage limit content fromhelp.html
, along with additional context/rendering niceties/screenshots./project-management/yanking/
with the yanking content fromhelp.html
, along with a short user tutorial on yanking releases.help.html
and changed the endpoints/views that linked it to link to the new docs page instead.Some open questions:
user_docs_url
request method 😅/project-management/
make sense as a hierarchy for these docs? Or should this be just a top level/storage-limits/
or similar, or something different?See #17702.
Closes #9013.