From 04387b02d96e65a42d40c07b23d97eaaceb6d36c Mon Sep 17 00:00:00 2001 From: Jitka Obselkova Date: Thu, 5 Jun 2025 10:13:47 +0200 Subject: [PATCH 1/2] Fix broken links --- README.md | 3 ++- docs/index.md | 2 +- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 468a8b73b..857fd1f2a 100644 --- a/README.md +++ b/README.md @@ -4,4 +4,5 @@ This is a command line interface for Pulp 3. This software is in beta and future releases may include backwards incompatible changes. -Check out our [docs](https://docs.pulpproject.org/pulp_cli/) and the [quickstart guide](https://docs.pulpproject.org/pulp_cli/installation/#tldr-get-started-real-fast) to get started. +Check out our [docs](https://docs.pulpproject.org/pulp_cli/) and the +[quickstart guide](https://pulpproject.org/pulp-cli/docs/user/guides/installation/#tldr-get-started-real-fast) to get started. diff --git a/docs/index.md b/docs/index.md index d734fccdf..e4b9526a9 100644 --- a/docs/index.md +++ b/docs/index.md @@ -8,7 +8,7 @@ Currently `pulp-cli` supports pulpcore and 6 of Pulp's plugins: `pulp_ansible`, See section below for information on how to extend the CLI to support other Pulp plugins. You can find workflow examples for the Pulp 3 CLI throughout the [plugin documentation](site:help/). -For example, [synchronizing a File repository](site:/pulp_file/docs/user/guides/01-sync/). +For example, [synchronizing a File repository](site:/pulp_file/docs/user/guides/sync/). Use the links on the left to navigate. From 9cb63865af60fc69499086b935bb0c30c09ccd39 Mon Sep 17 00:00:00 2001 From: Jitka Obselkova Date: Thu, 5 Jun 2025 10:19:00 +0200 Subject: [PATCH 2/2] Fix wrong formatting and typos --- docs/dev/guides/contributing.md | 2 +- docs/user/guides/configuration.md | 2 +- docs/user/reference/authentication.md | 9 ++++++--- 3 files changed, 8 insertions(+), 5 deletions(-) diff --git a/docs/dev/guides/contributing.md b/docs/dev/guides/contributing.md index d4876d56a..b92716695 100644 --- a/docs/dev/guides/contributing.md +++ b/docs/dev/guides/contributing.md @@ -51,7 +51,7 @@ And finally, for each new feature, we require corresponding tests. ## Testing Tests are shell scripts in `tests/scripts` with names like `test_*.sh`. -They should should focus on the cli operation and are not a replacement for pulp integration tests; +They should focus on the cli operation and are not a replacement for pulp integration tests; i.e. make sure the cli translates to the right api calls, but do not care about pulp internals. ## Running Tests diff --git a/docs/user/guides/configuration.md b/docs/user/guides/configuration.md index cb9c669fb..48a95d6dd 100644 --- a/docs/user/guides/configuration.md +++ b/docs/user/guides/configuration.md @@ -77,5 +77,5 @@ therefore you should install pulp-cli only on the primary server, and override t It can be helpful to use the `--profile` option here. As Katello uses Pulp as a backend, all modifying actions in Pulp should be performed via Katello. -Therefore you are also strongly encourged to set `dry_run = true`, to prevent accidentally calling into dangerous commands. +Therefore you are also strongly encouraged to set `dry_run = true`, to prevent accidentally calling into dangerous commands. This setting can in turn be overwritten on the command-line with the `--force` flag. diff --git a/docs/user/reference/authentication.md b/docs/user/reference/authentication.md index 97cd2a2ee..818f55309 100644 --- a/docs/user/reference/authentication.md +++ b/docs/user/reference/authentication.md @@ -6,10 +6,13 @@ Some very simple and common, like HTTP Basic Auth, and some more complex like OA ## OAuth2 ClientCredentials grant !!! warning - This is an experimental feature. The support of it could change without any major warning. -More on https://datatracker.ietf.org/doc/html/rfc6749#section-4.4 + This is an experimental feature. The support of it could change without any major warning. + + For more information, see [RFC6749 section 4.4]. Using this method the pulp-cli can request a token from an Identity Provider using a pair of -credentials (client_id/client_secret). The token is ten sent through using the `Authorization` header. +credentials (client_id/client_secret). The token is then sent through using the `Authorization` header. The issuer URL and the scope of token must be specified by the Pulp server through the OpenAPI scheme definition. + +[RFC6749 section 4.4]: https://datatracker.ietf.org/doc/html/rfc6749#section-4.4