Project

Profile

Help

Task #4620

Add quickstart guide to the left side

Added by bmbouter over 2 years ago. Updated almost 2 years ago.

Status:
CLOSED - CURRENTRELEASE
Priority:
Normal
Assignee:
Sprint/Milestone:
-
Start date:
Due date:
% Done:

100%

Estimated time:
Platform Release:
Groomed:
Yes
Sprint Candidate:
No
Tags:
Documentation
Sprint:
Sprint 51
Quarter:

Description

The quickstart section is designed to be short and have large blocks of copy/paste commands. Here are some examples:

https://www.rdoproject.org/tripleo/
http://docs.ceph.com/docs/mimic/start/quick-ceph-deploy/

1. Have a 1-line recommend an ansible-pulp installation with the commands to get into a pulplift test environment.
2. Have it install the rpm plugin
3. Have commands to Sync EPEL6 w/ lazy

This area could quickly get redundant with the existing workflows place, so it's possible this quickstart links to that content?

Associated revisions

Revision 013245ea View on GitHub
Added by bmbouter over 2 years ago

Added quickstart page

The quickstart page gets the user going with pulplift and helps them check the status API. From there it links to the already great workflows page.

This also fixed the readthedocs theme to be used which is important because only that theme renders the left-panel in a way that you can see this PR as it appears on the website. If you don't have the sphinx_rtd_theme package installed you get the default theme as a fallback.

https://github.com/rtfd/sphinx_rtd_theme

https://pulp.plan.io/issues/4620 closes #4620

Revision 573d1bcb View on GitHub
Added by bmbouter over 2 years ago

Quickstart page fixes

There were formatting errors and one term missing causing Sphinx build errors. This PR fixes those issues.

https://pulp.plan.io/issues/4620 closes #4620

History

#1 Updated by ttereshc over 2 years ago

  • Groomed changed from No to Yes
  • Sprint set to Sprint 51

#2 Updated by bmbouter over 2 years ago

  • Status changed from NEW to ASSIGNED
  • Assignee set to bmbouter

#3 Updated by bmbouter over 2 years ago

  • Status changed from ASSIGNED to POST

#4 Updated by bmbouter over 2 years ago

  • Status changed from POST to MODIFIED
  • % Done changed from 0 to 100

#5 Updated by bmbouter over 2 years ago

  • Status changed from MODIFIED to POST

Opening another PR fix so moving back to POST

#7 Updated by bmbouter over 2 years ago

  • Status changed from POST to MODIFIED

#8 Updated by bmbouter over 2 years ago

  • Tags deleted (Pulp 3)

#9 Updated by ttereshc almost 2 years ago

  • Status changed from MODIFIED to CLOSED - CURRENTRELEASE

Please register to edit this issue

Also available in: Atom PDF