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

Update docs for glue installation, mention maven #657

Merged
merged 1 commit into from
Mar 17, 2023
Merged

Update docs for glue installation, mention maven #657

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
1 change: 1 addition & 0 deletions CHANGES/654.doc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Fixed the installation from source instructions to include the glue layer.
1 change: 1 addition & 0 deletions CHANGES/656.doc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Added `pulp-cli-maven` to the list of known plugins.
5 changes: 3 additions & 2 deletions docs/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@ This is the documentation for Pulp 3's command line interface.

Here you can find information about how to install the Pulp 3 CLI, and general usage and syntax information.

Currently `pulp-cli` supports at a minimum the 5 latest versions of pulpcore and the corresponding compatible
Currently `pulp-cli` supports at a minimum the 5 latest versions of pulpcore and the corresponding compatible
versions of 5 Pulp's plugins: `pulp_ansible`, `pulp_container`, `pulp_file`, `pulp_python` and `pulp_rpm`.
See section below for information on how to extend the CLI to support other Pulp plugins.

Check out the [supported workflows section](supported_workflows) to learn about the capabilities of the CLI.
Check out the [supported workflows section](supported_workflows) to learn about the capabilities of the CLI.
You can find more workflow examples for the Pulp 3 CLI throughout the [plugin documentation](https://docs.pulpproject.org/pulpcore/plugins/index.html).
For example, [synchronizing a File repository](https://docs.pulpproject.org/pulp_file/workflows/sync.html).

Expand All @@ -24,4 +24,5 @@ Known plugins include:
| Plugin | Description | Source Repository |
| --- | --- | --- |
| `pulp-cli-deb` | Provides the `deb` subcommand group to interact with `pulp_deb`. | [`pulp/pulp-cli-deb`](https://github.com/pulp/pulp-cli-deb) |
| `pulp-cli-maven` | Provides the `maven` subcommand group to interact with `pulp_maven`. | [`pulp/pulp-cli-maven`](https://github.com/pulp/pulp-cli-maven) |
| `pulp-cli-ostree` | Provides the `ostree` subcommand group to interact with `pulp_ostree`. | [`pulp/pulp-cli-ostree`](https://github.com/pulp/pulp-cli-ostree) |
7 changes: 5 additions & 2 deletions docs/installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,9 +37,12 @@ pip install pulp-cli-deb
If you intend to use unreleased features, or want to contribute to the CLI, you can install from source:
```bash
git clone [email protected]:pulp/pulp-cli.git
pip install -e ./pulp-cli
pip install -e ./pulp-cli -e ./pulp-cli/pulp-glue --config-settings editable_mode=compat

# Optionally install plugins from source
git clone [email protected]:pulp/pulp-cli-deb.git
pip install -e ./pulp-cli-deb
pip install -e ./pulp-cli-deb --config-settings editable_mode=compat

git clone [email protected]:pulp/pulp-cli-maven.git
pip install -e ./pulp-cli-maven -e ./pulp-cli-maven/pulp-glue-maven --config-settings editable_mode=compat
```