From 18a58d96364304a9b6eeec9517099d3ed07283c2 Mon Sep 17 00:00:00 2001 From: Sean Roberts Date: Thu, 21 Nov 2013 21:00:40 -0800 Subject: [PATCH] front end restructure of training guides cleaned up first book with preface, getting started/under construction, and added common community support page. this is part of the overall restructure effort. implements bp/training-manuals Change-Id: I5c848a708998ceb1af88371d31adfa0f52f41a8d --- doc/training-guide/bk000-preface.xml | 126 +++++++++++++++++- doc/training-guide/st-training-guides.xml | 13 +- .../under-contruction-notice.xml | 122 ----------------- 3 files changed, 134 insertions(+), 127 deletions(-) delete mode 100644 doc/training-guide/under-contruction-notice.xml diff --git a/doc/training-guide/bk000-preface.xml b/doc/training-guide/bk000-preface.xml index 8d70d6ea36..508dcc5cb6 100644 --- a/doc/training-guide/bk000-preface.xml +++ b/doc/training-guide/bk000-preface.xml @@ -3,8 +3,128 @@ xmlns:xi="http://www.w3.org/2001/XInclude" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0" xml:id="bk001-preface"> - Preface - + Start Here + + Preface + - + + OpenStack Training Guides Are Under Construction + We need your help! This is a community driven project to provide the user group community + access to OpenStack training materials. We cannot make this work without your help. + There are few ways to get involved. The easiest way is to use the training guides. Look at + the end of each section and you will see the Submit a Bug link. When you find something that can + be improved or fixed, submit a bug by clicking on the link. + If you want to get involved with the effort around OpenStack community training, read on, + here are the options: + + + + Attending a user group using the training materials + The OpenStack community training started at the SFBay OpenStack User Group. More + information this user group and others using the training guides on the OpenStack User Groups + page. + + + + Teach / Lead a user group using the training materials + Awesome! Your experience will not only give you more experience with OpenStack, but + you will help some people find new jobs. We have put all the information about How To Run An OpenStack Hackathon here. + + + + Helping to create the training pages + + + + We are currently working on creating the Associate Training Guide. It is the + first of four training guides. We are using the Install Guide, Administration + Guides, Developer Documentation, and Aptira supplied content as the sources for + most of the Associate Training Guide. The basic idea is we use XML include + statements to actually use the source content to create new pages. We aim to use + as much of the material as possible from existing documentation. By doing this + we reuse and improve the existing docs. The topics in the Associate Training + Guide are in a bunch of KanBan story board cards. Each card in the story board + represents something that an Associate trainee needs to learn. But first things + first, you need to get some basic tools and accounts installed and configured + before you can really start. + + + Getting Accounts and Tools: We can't do + this without operators and developers using and creating the content. Anyone can + contribute content. You will need the tools to get started. Go to the Getting Tools and Accounts page. + + + Pick a Card: Once you have your tools ready + to go, you can assign some work to yourself. Go to the Training Trello/KanBan storyboard and assign a card / user story from + the Sprint Backlog to yourself. If you don't have a Trello account, no problem, + just create one. Email seanrob@yahoo-inc.com and you will have access. + + + Create the Content: Each card / user story + from the KanBan story board will be a separate chunk of content that you will + add to the openstack-manuals repository openstack-training sub-project. + More details on creating training + content here. + + + + + + Here are more details on commiting changes to OpenStack fixing a documentation bug , OpenStack Gerrit + Workflow, OpenStack + Documentation HowTo and , Git + Documentation + + + + + More details on the OpenStack Training project. + + + + OpenStack Training + Wiki (describes the project in detail) + + + OpenStack Training blueprint(this is the key project page) + + + Bi-Weekly SFBay Hackathon meetup + page(we discuss project details with all team members) + + + Bi-Weekly SFBay + Hackathon Etherpad(meetup notes) + + + Core + Training Weekly Meeting Agenda(we review project action items here) + + + Training Trello/KanBan storyboard(we develop high level project action items + here) + + + + Submit a bug. Enter the summary as "Training, " with a few words. Be descriptive as possible in the description field. Open the tag pull-down and enter training-manuals. + + + + \ No newline at end of file diff --git a/doc/training-guide/st-training-guides.xml b/doc/training-guide/st-training-guides.xml index bd4e895d33..9cf99ce1ed 100644 --- a/doc/training-guide/st-training-guides.xml +++ b/doc/training-guide/st-training-guides.xml @@ -17,7 +17,6 @@ 2013 OpenStack Foundation - Havana, 2013.2 OpenStack Training Guides @@ -35,6 +34,16 @@ + + 2013-11-04 + + + + major restructure of guides + + + + 2013-09-11 @@ -87,7 +96,7 @@ Aptira - + diff --git a/doc/training-guide/under-contruction-notice.xml b/doc/training-guide/under-contruction-notice.xml deleted file mode 100644 index 9cce480daa..0000000000 --- a/doc/training-guide/under-contruction-notice.xml +++ /dev/null @@ -1,122 +0,0 @@ - - - Start Here - OpenStack Training Guides Are Under Construction - We need your help! This is a community driven project to provide the user group community - access to OpenStack training materials. We cannot make this work without your help. - There are few ways to get involved. The easiest way is to use the training guides. Look at - the end of each section and you will see the Submit a Bug link. When you find something that can - be improved or fixed, submit a bug by clicking on the link. - If you want to get involved with the effort around OpenStack community training, read on, - here are the options: - - - - Attending a user group using the training materials - The OpenStack community training started at the SFBay OpenStack User Group. More - information this user group and others using the training guides on the OpenStack User Groups - page. - - - - Teach / Lead a user group using the training materials - Awesome! Your experience will not only give you more experience with OpenStack, but - you will help some people find new jobs. We have put all the information about How To Run An OpenStack Hackathon here. - - - - Helping to create the training pages - - - - We are currently working on creating the Associate Training Guide. It is the - first of four training guides. We are using the Install Guide, Administration - Guides, Developer Documentation, and Aptira supplied content as the sources for - most of the Associate Training Guide. The basic idea is we use XML include - statements to actually use the source content to create new pages. We aim to use - as much of the material as possible from existing documentation. By doing this - we reuse and improve the existing docs. The topics in the Associate Training - Guide are in a bunch of KanBan story board cards. Each card in the story board - represents something that an Associate trainee needs to learn. But first things - first, you need to get some basic tools and accounts installed and configured - before you can really start. - - - Getting Accounts and Tools: We can't do - this without operators and developers using and creating the content. Anyone can - contribute content. You will need the tools to get started. Go to the Getting Tools and Accounts page. - - - Pick a Card: Once you have your tools ready - to go, you can assign some work to yourself. Go to the Training Trello/KanBan storyboard and assign a card / user story from - the Sprint Backlog to yourself. If you don't have a Trello account, no problem, - just create one. Email seanrob@yahoo-inc.com and you will have access. - - - Create the Content: Each card / user story - from the KanBan story board will be a separate chunk of content that you will - add to the openstack-manuals repository openstack-training sub-project. - More details on creating training - content here. - - - - - - Here are more details on commiting changes to OpenStack fixing a documentation bug , OpenStack Gerrit - Workflow, OpenStack - Documentation HowTo and , Git - Documentation - - - - - More details on the OpenStack Training project. - - - - OpenStack Training - Wiki (describes the project in detail) - - - OpenStack Training blueprint(this is the key project page) - - - Bi-Weekly SFBay Hackathon meetup - page(we discuss project details with all team members) - - - Bi-Weekly SFBay - Hackathon Etherpad(meetup notes) - - - Core - Training Weekly Meeting Agenda(we review project action items here) - - - Training Trello/KanBan storyboard(we develop high level project action items - here) - - - - Submit a bug. Enter the summary as "Training, " with a few words. Be descriptive as possible in the description field. Open the tag pull-down and enter training-manuals. - - -