Project

Profile

Help

Issue #8550

Issue #8477: As a new Pulp user, I would like well-described getting started information about using the Pulp installer

Mismatch between pulpcore instructions on pulp_installer and the pulp_installer docs

Added by mdepaulo@redhat.com 4 months ago. Updated 2 months ago.

Status:
CLOSED - CURRENTRELEASE
Priority:
Normal
Assignee:
Category:
-
Sprint/Milestone:
Start date:
Due date:
Estimated time:
Severity:
2. Medium
Version:
Platform Release:
OS:
Triaged:
Yes
Groomed:
No
Sprint Candidate:
No
Tags:
Documentation, Easy Fix
Sprint:
Quarter:

Description

On the main Pulpcore docs page, we have a section titled Ansible installer (Recommended) where we have some commands relating to the Ansible installer, but we never explicitly state that we have a more comprehensive set of docs elsewhere: https://docs.pulpproject.org/pulpcore/installation/instructions.html#ansible-installation-recommended

If I was a new user, I might disappear at this point for lack of direction. @mikedep333 also pointed out that there is an error in this set of docs. mcorr thinks that it is poor practice to have two sets of docs like this on the go.

We should explicitly state that this is a short introduction to the installer, and ask the users to check out the more comprehensive guide to the installer at the different URL. If these docs are to remain duplicated, we must add a step to the installer release process to check these docs in pulpcore in the weeks leading up to a release.

Note: At the recent pulp_installer meeitng, I (mikedep333) seem to recall us agreeing that we should just remove the duplicate instructions from the pulpcore docs, and link to the installer docs.

EDIT: Just confirmed this at the 4/14 meeting.

Associated revisions

Revision 4073bd28 View on GitHub
Added by mcorr 3 months ago

Remove pulp installer doc sample

fixes #8550

History

#1 Updated by mdepaulo@redhat.com 4 months ago

  • Description updated (diff)

#2 Updated by mdepaulo@redhat.com 4 months ago

  • Description updated (diff)

#3 Updated by mdepaulo@redhat.com 4 months ago

  • Triaged changed from No to Yes
  • Tags Easy Fix added

#4 Updated by mdepaulo@redhat.com 4 months ago

  • Category deleted (Installer)

#5 Updated by mcorr 3 months ago

Hey @mikedep333 Is the direction we are going in to remove the example installer docs in Pulpcore? If so, I am happy to do this.

#6 Updated by mcorr 3 months ago

  • Assignee set to mcorr

#7 Updated by pulpbot 3 months ago

  • Status changed from NEW to POST

#8 Updated by mcorr 3 months ago

  • Status changed from POST to MODIFIED

#9 Updated by dalley 2 months ago

  • Sprint/Milestone set to 3.13.0

#10 Updated by pulpbot 2 months ago

  • Status changed from MODIFIED to CLOSED - CURRENTRELEASE

Please register to edit this issue

Also available in: Atom PDF