Skip to content
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 1 commit into from
Jul 17, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# Role Base Access Control in Pulp Python

Role based access control in Pulp Python is configured using access policies for the following `viewset_names`:

* `content/python/packages`
* `distributions/python/pypi`
* `publications/python/pypi`
Expand All @@ -14,7 +15,7 @@ Role based access control in Pulp Python is configured using access policies for

This document will focus on describing the default access policies for the PyPI specific APIs and how they may be
customized. The access policies for the Pulp APIs follow the same scheme as the Pulp File plugin which can be read
about here: [Pulp File RBAC](https://docs.pulpproject.org/pulp_file/role-based-access-control.html). Use the Pulp
about here: [Pulp File RBAC](site:pulp_file/docs/admin/guides/01-rbac/). Use the Pulp
CLI to follow along with the examples here.

!!! note
Expand Down
38 changes: 38 additions & 0 deletions staging_docs/index.md
Copy link
Member

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

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.
59 changes: 0 additions & 59 deletions staging_docs/user/guides/00-overview.md

This file was deleted.

77 changes: 0 additions & 77 deletions staging_docs/user/guides/01-pypi.md

This file was deleted.

193 changes: 0 additions & 193 deletions staging_docs/user/guides/02-sync.md

This file was deleted.

Loading
Loading