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.

Sign up for GitHub

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

Nitpicks on the staging docs #220

Merged
merged 1 commit into from
Feb 27, 2024
Merged

Nitpicks on the staging docs #220

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
3 changes: 2 additions & 1 deletion staging_docs/user/guides/01-upload.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,8 @@ Start by creating a new repository named "foo".

## 2. Upload a file to Pulp

Each artifact in Pulp represents a file. They can be created during sync or created manually by uploading a file
Each artifact in Pulp represents a file.
They can be created during sync or created manually by uploading a file:

=== "run"
```bash
Expand Down
9 changes: 4 additions & 5 deletions staging_docs/user/guides/02-sync.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,10 @@
# Synchronize a Repository

Users can populate their repositories with content from an external sources by syncing
their repository.
Users can populate their repositories with content from an external sources by syncing their repository.

## 1. Create a Repository

Start by creating a new repository named "foo"
Start by creating a new repository named "foo":

=== "run"
```bash
Expand All @@ -28,7 +27,7 @@ Start by creating a new repository named "foo"

## 2. Create a Remote

Create a remote that syncs all versions of panda into your repository.
Create a remote that syncs all versions of the `panda` gem into your repository.

=== "run"
```bash
Expand Down Expand Up @@ -74,7 +73,7 @@ Create a remote that syncs all versions of panda into your repository.
## 3. Sync repository foo with remote

Use the remote object to kick off a synchronize task by specifying the repository to sync with.
You are telling pulp to fetch content from the remote and add to the repository
You are telling pulp to fetch content from the remote and add to the repository:

=== "run"
```bash
Expand Down
19 changes: 11 additions & 8 deletions staging_docs/user/guides/03-publish.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@ See [Sync](site:pulp_gem/docs/user/guides/sync/) or [Upload](site:pulp_gem/docs/

## 1. Create a Publication

Kick off a publish task by creating a new publication. The publish task will generate all the
metadata that `gem` needs to install packages (although it will need to be hosted through a
Distribution before it is consumable).
Kick off a publish task by creating a new publication.
The publish task will generate all the metadata that `gem` needs to install packages
(although it will need to be hosted through a Distribution before it is consumable).

=== "run"
```bash
Expand All @@ -29,7 +29,8 @@ Distribution before it is consumable).

## 2. Host a Publication by creating a Distribution

To host a publication, (which makes it consumable by `gem`), users create a distribution which will serve the associated publication at `/pulp/content/<distribution.base_path>`
To host a publication, (which makes it consumable by `gem`),
users create a distribution which will serve the associated publication at `/pulp/content/<distribution.base_path>`

=== "run"
```bash
Expand All @@ -55,13 +56,14 @@ To host a publication, (which makes it consumable by `gem`), users create a dist
```

!!! note
Alternatively you could specify the repository when creating a distribution in which case Pulp will automatically distribute the latest available publication for the greatest repository version
Alternatively you could specify the repository when creating a distribution.
In this case Pulp will automatically distribute the newest available publication for the latest repository version.


## 3. Enable Pull-Through Caching:

Only gems present in your repository will be available from your index, but adding a remote source to
your distribution will enable the pull-through cache feature.
Only gems present in your repository will be available from your index,
but adding a remote source to your distribution will enable the pull-through cache feature.

This feature allows you to install any gem from the remote source and have Pulp store that gem as orphaned content.

Expand All @@ -71,7 +73,8 @@ pulp gem distribution update --name foo --remote gem

!!! warning
Support for pull-through caching is provided as a tech preview in Pulp 3.
Functionality may not work or may be incomplete. Also, backwards compatibility when upgrading is not guaranteed.
The functionality may not work or may be incomplete.
Also, backwards compatibility when upgrading is not guaranteed.


## 4. Use the newly created distribution
Expand Down
55 changes: 21 additions & 34 deletions staging_docs/user/tutorials/quickstart.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,47 +1,34 @@
# User Setup

All workflow examples use the Pulp CLI. Install and setup from PyPI:
### Server Installation
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We've discussed about using oci-images as the main source of installation info.
So I think it is enough to provide their quickstart, which is already in the staging-site here.

To add an internal link for https://staging-docs.pulpproject.org/pulp-oci-images/docs/admin/tutorials/quickstart/ you should use a pattern of [name](site:url-path.md):

[Installation Quickstart](site:pulp-oci-images/docs/admin/tutorials/quickstart.md)


```bash
pip install pulp-cli[pygments] pulp-cli-gem
pulp config create -e
pulp status # Check that CLI can talk to Pulp
```
Follow the [Installation Quickstart](site:pulp-oci-images/docs/admin/tutorials/quickstart.md) instructions to get started with Pulp.
Further details are discussed in the [pulpcore documentation](https://docs.pulpproject.org/pulpcore/installation/instructions.html).

If you configured the `admin` user with a different password, adjust the configuration
accordingly. If you prefer to specify the username and password with each request, please see
`Pulp CLI` documentation on how to do that.
### CLI Installation

### Install
All workflow examples use the [Pulp CLI](https://docs.pulpproject.org/pulp_cli/).
Install and setup from PyPI:

=== "Containerized Installation"

Follow the [Pulp in One Container](https://pulpproject.org/pulp-in-one-container/) instructions to get started with Pulp by
leveraging OCI images. Further details are discussed in the [pulpcore documentation](https://docs.pulpproject.org/pulpcore/installation/instructions.html).

=== "From Source"
=== "pip"

```bash
sudo -u pulp -i
source ~/pulp/bin/activate
cd pulp_gem
pip install -e .
django-admin runserver 24817
pip install pulp-cli[pygments] pulp-cli-gem

pulp config create -e
pulp status # Check that CLI can talk to Pulp
```

### Make and Run Migrations
=== "pipx"

```bash
pulp-manager makemigrations pulp_gem
pulp-manager migrate pulp_gem
```
```bash
pipx install pulp-cli[pygments]
pipx inject pulp-cli pulp-cli-gem

### Run Services
pulp config create -e
pulp status # Check that CLI can talk to Pulp
```

```bash
pulp-manager runserver
gunicorn pulpcore.content:server --bind 'localhost:24816' --worker-class 'aiohttp.GunicornWebWorker' -w 2
sudo systemctl restart pulpcore-resource-manager
sudo systemctl restart pulpcore-worker@1
sudo systemctl restart pulpcore-worker@2
```
If you configured the `admin` user with a different password, adjust the configuration accordingly.
If you prefer to specify the `username` and `password` with each request,
please see [`Pulp CLI` documentation](https://docs.pulpproject.org/pulp_cli/configuration/) on how to do that.
Loading