Issue #2808: Clarify use of `pulp-consumer` - Pulp

Actions

Send by e-mail Copy link

Issue #2808

closed

Clarify use of `pulp-consumer`

Added by kdelee@redhat.com almost 6 years ago. Updated almost 3 years ago.

Status:

CLOSED - CURRENTRELEASE

Priority:

Normal

Assignee:

kdelee@redhat.com

Category:

Sprint/Milestone:

Start date:

Due date:

Estimated time:

Severity:

1. Low

Version:

Platform Release:

2.14.0

OS:

Triaged:

Yes

Groomed:

Sprint Candidate:

Tags:

Documentation, Easy Fix, Pulp 2

Sprint:

Quarter:

Description

Documentation could be clearer about use of pulp-consumer. While reading the Quick Start Guide[0] it was not clear that pulp-consumer must be run as root.

This fact is mentioned under the user-guide/consumer-client page of the docs[1], but other parts of the docs vacillate between using:

$ sudo pulp-consumer ...

or just plain

$ pulp-consumer

To make it clear, perhaps use:

# pulp-consumer ...

or preface every invocation shown in examples with

$ sudo pulp-consumer ....

[0] http://docs.pulpproject.org/plugins/pulp_rpm/user-guide/quick-start.html
[1] http://docs.pulpproject.org/user-guide/consumer-client/register.html#pre-registration-authentication

Actions

Copy link

Updated by kdelee@redhat.com almost 6 years ago

Copied from Task #2790: Add documentation about PR builder added

Actions

Copy link

Updated by kdelee@redhat.com almost 6 years ago

Just found the note that the `#` symbol should be avoided [0], so I suppose that leaves the `$ sudo pulp-consumer ...` option

[0] http://docs.pulpproject.org/en/2.12/dev-guide/contributing/documenting.html#command-line-user-guide

Actions

Copy link

Updated by bmbouter almost 6 years ago

Description updated (diff)

I think the user only need sudo for some actions with pulp-consumerwhich is part of the confusion. I recommend adding a "Sphinx note" saying that if you get a permission denied to try it with sudo as general advice and have all command disinclude sudo in the examples.

I also rewrote the description a bit with more formatting.

Actions

Copy link