-
Notifications
You must be signed in to change notification settings - Fork 77
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
Fixup new docs #701
Merged
Merged
Fixup new docs #701
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
File renamed without changes.
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,38 @@ | ||
# Welcome to Pulp Python | ||
|
||
The `python` plugin extends [pulpcore](site:pulpcore/) to support | ||
hosting python packages. This plugin is a part of the [Pulp Project](site:/), and assumes some familiarity with the [pulpcore documentation](site:pulpcore/). | ||
|
||
If you are just getting started, we recommend getting to know the [basic | ||
workflows](site:pulp_python/docs/user/guides/pypi/). | ||
|
||
The REST API documentation for `pulp_python` is available [here](site:pulp_python/restapi/). | ||
|
||
## Features | ||
|
||
- [Create local mirrors of PyPI](site:pulp_python/docs/user/guides/sync/) that you have full control over | ||
- [Upload your own Python packages](site:pulp_python/docs/user/guides/upload/) | ||
- [Perform pip install](site:pulp_python/docs/user/guides/publish/) from your Pulp Python repositories | ||
- Download packages on-demand to reduce disk usage | ||
- Every operation creates a restorable snapshot with Versioned Repositories | ||
- Curate your Python repositories with allowed and disallowed packages | ||
- Host content either locally or on S3/Azure/GCP | ||
- De-duplication of all saved content | ||
|
||
## Tech Preview | ||
|
||
Some additional features are being supplied as a tech preview. There is a possibility that | ||
backwards incompatible changes will be introduced for these particular features. For a list of | ||
features currently being supplied as tech previews only, see the [tech preview page](site:pulp_python/docs/user/learn/tech-preview/). | ||
|
||
# How to use these docs | ||
|
||
The documentation here should be considered the **primary documentation for managing Python related content.** | ||
All relevant workflows are covered here, with references to some pulpcore supplemental docs. | ||
Users may also find pulpcore’s conceptual docs useful. | ||
|
||
This documentation falls into two main categories: | ||
|
||
1. `How-to Guides` shows the **major features** of the Python plugin, with links to reference docs. | ||
2. The [REST API Docs](site:pulp_python/restapi/) are automatically generated and provide more detailed information for each | ||
minor feature, including all fields and options. |
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
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.
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.
This page still has the production urls for internal links, use the
[](site:{path})
here too