Create beginner-friendly getting started with devstack docs

Bug #1375288 reported by Cindy Pallares on 2014-09-29
12
This bug affects 2 people
Affects Status Importance Assigned to Milestone
devstack
Undecided
Unassigned

Bug Description

Even though the devstack page has really handy script pages, it would be nice to have a documentation page that not only takes you through the process of installing devstack, but gives information on more things, like using the screen for example. This type of documentation would be really helpful for onboarding, newcomers interested in developing, as well as interested applicants for the outreach program for women and google summer of code.
Right now, the learning curve is really steep for a newcomer to understand and trace a bug using devstack.

A good start to add to a beginner-friendly step-by-step guide is:
-What is local.config, how to you can customize devstack, and add other projects (such as Ceilometer).
-When to use stack.sh, unstack.sh and clean.sh
-How the screen command can be helpful in devstack

description: updated
description: updated
Changed in devstack:
assignee: nobody → vishwanath jayaraman (vishwanathj)

Hi Vishwanath, Are you working on this bug?

description: updated
Changed in devstack:
status: New → In Progress
Changed in devstack:
assignee: vishwanath jayaraman (vishwanathj) → nobody
Changed in devstack:
status: In Progress → Confirmed
Changed in devstack:
assignee: nobody → Steve Wilkerson (sw5822)
Changed in devstack:
status: Confirmed → In Progress
Remo Mattei (remo-o) wrote :

I have helped Mirantis in the training where devstack was used in every class, I will be happy to write steps on this. Let me know if this is still open. I can do this the next couple of days. Thanks

Changed in devstack:
assignee: Steve Wilkerson (sw5822) → nobody
Changed in devstack:
assignee: nobody → Steve Wilkerson (sw5822)
Changed in devstack:
assignee: Steve Wilkerson (sw5822) → nobody
clayg (clay-gerrard) on 2017-02-21
Changed in devstack:
status: In Progress → New
clayg (clay-gerrard) wrote :

https://docs.openstack.org/developer/devstack/index.html is great onramp - but the lack of a TOC is ... surprising?

On inspecting the source it seems most (all?) of the pages defined in the doc/source [1] *are* linked from index.html [2].

But IMOH the conversational tone makes navigation unnecessarily difficult - and in most cases the section titles are descriptive and useful. The site-map [3] is an invaluable resource and need to some be a likely navigation target for people experiencing the devstack doc tree for the first time.

Sean Dague (sdague) on 2017-06-27
Changed in devstack:
status: New → Fix Released
To post a comment you must log in.
This report contains Public information  Edit
Everyone can see this information.

Other bug subscribers