Skip to content

Commit 69b2301

Browse files
committed
Fixup new docs
[noissue]
1 parent 0546d65 commit 69b2301

File tree

12 files changed

+497
-496
lines changed

12 files changed

+497
-496
lines changed

staging_docs/user/guides/05-rbac.md renamed to staging_docs/admin/guides/rbac.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
# Role Base Access Control in Pulp Python
22

33
Role based access control in Pulp Python is configured using access policies for the following `viewset_names`:
4+
45
* `content/python/packages`
56
* `distributions/python/pypi`
67
* `publications/python/pypi`
@@ -14,7 +15,7 @@ Role based access control in Pulp Python is configured using access policies for
1415

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

2021
!!! note

staging_docs/index.md

+38
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# Welcome to Pulp Python
2+
3+
The `python` plugin extends [pulpcore](site:pulpcore/) to support
4+
hosting python packages. This plugin is a part of the [Pulp Project](site:/), and assumes some familiarity with the [pulpcore documentation](site:pulpcore/).
5+
6+
If you are just getting started, we recommend getting to know the [basic
7+
workflows](site:pulp_python/docs/user/guides/pypi/).
8+
9+
The REST API documentation for `pulp_python` is available [here](site:pulp_python/restapi/).
10+
11+
## Features
12+
13+
- [Create local mirrors of PyPI](site:pulp_python/docs/user/guides/sync/) that you have full control over
14+
- [Upload your own Python packages](site:pulp_python/docs/user/guides/upload/)
15+
- [Perform pip install](site:pulp_python/docs/user/guides/publish/) from your Pulp Python repositories
16+
- Download packages on-demand to reduce disk usage
17+
- Every operation creates a restorable snapshot with Versioned Repositories
18+
- Curate your Python repositories with allowed and disallowed packages
19+
- Host content either locally or on S3/Azure/GCP
20+
- De-duplication of all saved content
21+
22+
## Tech Preview
23+
24+
Some additional features are being supplied as a tech preview. There is a possibility that
25+
backwards incompatible changes will be introduced for these particular features. For a list of
26+
features currently being supplied as tech previews only, see the [tech preview page](site:pulp_python/docs/user/learn/tech-preview/).
27+
28+
# How to use these docs
29+
30+
The documentation here should be considered the **primary documentation for managing Python related content.**
31+
All relevant workflows are covered here, with references to some pulpcore supplemental docs.
32+
Users may also find pulpcore’s conceptual docs useful.
33+
34+
This documentation falls into two main categories:
35+
36+
1. `How-to Guides` shows the **major features** of the Python plugin, with links to reference docs.
37+
2. The [REST API Docs](site:pulp_python/restapi/) are automatically generated and provide more detailed information for each
38+
minor feature, including all fields and options.

staging_docs/user/guides/00-overview.md

-59
This file was deleted.

staging_docs/user/guides/01-pypi.md

-77
This file was deleted.

staging_docs/user/guides/02-sync.md

-193
This file was deleted.

0 commit comments

Comments
 (0)