Difference between revisions of "Training-guides"
(→Incubation Plan) |
(→Incubation Plan) |
||
Line 133: | Line 133: | ||
== Incubation Plan == | == Incubation Plan == | ||
− | OpenStack projects start as stackforge projects in the GitHub organization Stackforge here https://github.com/stackforge. There are some simple rules, but not much team structure or contribution is required. | + | OpenStack projects generally start as stackforge projects in the GitHub organization Stackforge here https://github.com/stackforge. There are some simple rules, but not much team structure or contribution is required. The Training Guides project is a bit unusual as the project started and has been located within the openstack/openstack-manuals repository since mid 2013 already. Due to this project already being in the Openstack github organization, it will move from openstack/openstack-manuals to openstack/training-guides. The patch to do that is here https://review.openstack.org/#/c/96334/. The Training Guides project will continue to publish html to http://docs.openstack.org/training-guides. |
+ | |||
+ | '''''The Training Guides project desires to be an incubated OpenStack project. This desire will be discuss with the Technology Committee for Juno Milestone-2. In the meantime, sarob and annegentle will work on the Incubation Plan below.''''' | ||
The official TC governance is here https://wiki.openstack.org/wiki/Governance/Approved/Incubation | The official TC governance is here https://wiki.openstack.org/wiki/Governance/Approved/Incubation |
Revision as of 18:52, 10 June 2014
openstack-training docs http://docs.openstack.org/training-guides weekly meeting agenda https://wiki.openstack.org/wiki/Meetings/training-manuals weekly meeting history http://eavesdrop.openstack.org/meetings/training_manuals launchpad project page https://launchpad.net/openstack-training-guides
Contents
- 1 Project Goals
- 2 Project Status
- 3 Project Sub-Groups
- 4 Project Management
- 5 Team Responsibilities
- 6 stable sub-project
- 7 development sub-project
- 8 testing sub-project
- 9 infrastructure sub-project
- 10 audio visual sub-project
- 11 Book structure
- 12 Incubation Plan
- 13 Last edit 55430 by Sarob on 20140610185216 (year+month+day+UTC hour+seconds)
- 14 training manuals core leaders sarob and colinmcnamara
Project Goals
- Provide a structured training program to enable skill development for maintaining, consuming, and contributing to OpenStack
- Align to the OpenStack Foundation certification program as it evolves
- Increase accuracy and usability of documentation and training by engaging user groups and community members across the world
- Increase the amount of skilled engineers and developers in the hiring pool for OpenStack operators and developers
- Enable underrepresented / economically disadvantaged users groups and communities (Africa, Vietnam, Etc) to develop valuable and marketable skills.
- We will be targeting the user group and university audiences first while partnering with commercial interests like Aptira. Commercial interests are encouraged to use and contribute to the project.
- We aim to have as many commercial training programs use this project for the 'core' of their training. It will only improve the quality of the content while limiting the quantity to just the very most important bits.
- Reuse the openstack foundation guides with some additional training specific pages
- Target 80% OpenStack manuals reuse
- Same contribution process as existing guides
- Training material and lab work will be based on defcore/refstack (this work is ongoing so no project impact at this time)
Project Status
- Currently an incubated project under OpenStack Manuals (PTL = Anne Gentle)
- Currently focused - OpenStack Developer Course Launch
Project Sub-Groups
- stable: (dguitarbite lead) keep the existing training materials up to date and tracking with the current documentation and stable release code. Unless there needs to be a major change, all of the Stable work will be done through bugs.
- development: (sarob lead) work on creating the new materials. All the Development work will be done through blueprints.
- testing: (matjazp lead) curators of the quiz and test questions. The Testing work will be blueprints (new features) and bugs (updating existing materials).
- infrastructure: (rl, dguitarbite leads) maintain the trainer tools and testing system. The Infrastructure work will be blueprints (new features) and bugs (updating existing materials).
- audio visual (AV): (TBD lead) create images, video, and graphics that promote and assist the training project
Project Management
- New design ideas and major changes will be submitted for team review by committing a spec RST patch. After approval, the blueprint following the spec will be created.
- in Launchpad, the blueprint contains design ideas and status
- in Launchpad bugs on the published documentation will be posted,
- on this wiki page the project status and overview will be posted
Team Responsibilities
- sub-team leads/core-reviewers:
- attend weekly IRC meets,
- attend core sprints when called,
- work through gerrit reviews of bugs and patches
- reviewers, contributors:
- when you can, attend weekly IRC meets,
- when you can, attend core sprints when called,
- work through gerrit reviews of bugs and patches,
- contribute patches
- community:
- work on submitting bugs, fixing bugs,
- suggest new material.
- All are welcome to participate.
stable sub-project
- (X) specs to be created for the current stable sub-project focus, the associate and operators training guides
- outstanding actions/info from last meeting http://eavesdrop.openstack.org/meetings/training_manuals/2014/training_manuals.2014-06-09-17.03.html
- https://bugs.launchpad.net/devstack/+bug/1320535 (rluethi, 17:17:04)
- ACTION: infra team to explore new tests (sarob, 17:17:13)
- ACTION: sarob move over content to stackforge training-guides repo (sarob, 17:17:56)
- ACTION: dguitarbite update training-manuals wiki with the recent changes, sub-groups and their leads (dguitarbite, 17:18:58)
- ACTION: sarob will create spec subdir (sarob, 17:20:24)
- ACTION: training team will start following the spec to blueprints process (sarob, 17:20:55)
- ACTION: trello use will be discontinued (sarob, 17:21:23)
- ACTION: sarob will announced trello discontinue on docs ML and trello (sarob, 17:22:42)
development sub-project
- (10) specs to be created for the current development sub-project focus, the developer training guide
- specs based on https://docs.google.com/document/d/17949LwkTd2a8fkQwHxtifZqxp309BdHxKD9sSYG4OD8/edit?usp=sharing
- developer training guide prerequisites
- developer training guide how to participate classroom
- developer training guide how to participate quizzes
- developer training guide how to participate labs
- developer training guide APIs deep dive classroom
- developer training guide APIs deep dive quizzes
- developer training guide APIs deep dive labs
- developer training guide assessment
- developer training guide 1 day bootcamp
- developer training guide 2 day bootcamp
- outstanding actions/info from last meeting http://eavesdrop.openstack.org/meetings/training_manuals/2014/training_manuals.2014-06-09-17.03.html
- COMPLETED comcast new devs being trained this week. They will join the meeting next week. (sarob, 17:36:42)
testing sub-project
- (X) specs to be created for the testing sub-project
- outstanding actions/info from last meeting http://eavesdrop.openstack.org/meetings/training_manuals/2014/training_manuals.2014-06-09-17.03.html
- ACTION: COMPLETED sarob invite mark collier to next meeting to discuss status of foundation training certification (sarob, 17:26:43)
- ACTION: dguitarbite update wiki stable state and plans (sarob, 17:31:35)
- ACTION: matjazp update wiki testing state and plans (sarob, 17:32:10)
infrastructure sub-project
- (X) specs to be created for the testing sub-project
- outstanding actions/info from last meeting http://eavesdrop.openstack.org/meetings/training_manuals/2014/training_manuals.2014-06-09-17.03.html
- ACTION: rluethi, dguitarbite update wiki infra section (sarob, 17:42:09)
- ACTION: CANCELLED training infra team patch Openstack infra for creating, logging channel #openstack-training-guides (sarob, 17:49:39)
- ACTION: infra team set irc bouncer znc for the training team whole (sarob, 17:53:50)
- ACTION: training team core reviewers need to use irc bouncer (sarob, 17:54:24)
audio visual sub-project
Once a team lead volunteers, the team lead will update this section ASAP
Book structure
- each book needs goals that slightly overlap with the previous and next
- 10 question quiz and 1 scenario at the end of each chapter
- 40+ assessment broken down by each section/question representing a different chapter
- hierarchy: set -> book -> chapter -> section
- book topics
- openstack associate engineer
- openstack operator engineer
- openstack developer engineer
- openstack devOps architect
- publish to docs.openstack.org/training-guides
Book openstack associate
- training would take 1 month self paced, (2) 2 week periods with a user group meeting, or 16 hours instructor led. Some time set aside for distro specific training.
- basic knowledge of core OpenStack components (Compute, Block, Network, Dashboard)
- for the rest see the associate guide online
Book openstack operations engineer
- training would take 2.5 months self paced, (5) 2 week periods with a user group meeting, or 40 hours instructor led with 40 hours of self paced lab time. May set aside some time for distro specific training.
- for the rest see the operator guide online
Book openstack development engineer
- build on concepts from Operator training
- combine how to contribute and working with CI guides into a developers guide
- training would take 2.5 months self paced, (5) 2 week periods with a user group meeting, or 40 hours instructor led with 40 hours of self paced lab time. May set aside some time for distro specific training.
- outline is here
Book openstack devOps architect
- training would take 6 months or (12) 2 week periods with a user group meeting. 240 hours of self paced lab time.
- Meant to be very hard to complete. Public contribution must be a considerable part of the work completed.
- The Architect focuses on a specific OpenStack project as a specialization and becomes a working member of that project. The Architect training will be all about becoming a functioning member of the OpenStack open source community.
- speaking at user groups
- summit session submissions should all count towards karma/contribution
- Passing DevOps training would make the person desirable as an employee.
- Passing DevOps training would make the person desirable as a core contributor to any project
Incubation Plan
OpenStack projects generally start as stackforge projects in the GitHub organization Stackforge here https://github.com/stackforge. There are some simple rules, but not much team structure or contribution is required. The Training Guides project is a bit unusual as the project started and has been located within the openstack/openstack-manuals repository since mid 2013 already. Due to this project already being in the Openstack github organization, it will move from openstack/openstack-manuals to openstack/training-guides. The patch to do that is here https://review.openstack.org/#/c/96334/. The Training Guides project will continue to publish html to http://docs.openstack.org/training-guides.
The Training Guides project desires to be an incubated OpenStack project. This desire will be discuss with the Technology Committee for Juno Milestone-2. In the meantime, sarob and annegentle will work on the Incubation Plan below.
The official TC governance is here https://wiki.openstack.org/wiki/Governance/Approved/Incubation Below are the incubation requirements from the TC from https://github.com/openstack/governance/blob/master/reference/incubation-integration-requirements.rst as of 03jun2014. This RST is still under development. Likely our incubation proposal will be debated within the TC in an etherpad.
The TC will evaluate the project scope and its complementarity with existing integrated projects and other official programs, look into the project technical choices, and check a number of requirements, including (but not limited to):
Scope
Project must have a clear and defined scope.
We do. https://wiki.openstack.org/wiki/Training-guides#Project_Goals
Project's scope should represent a measured progression for OpenStack as a whole.
As the training-guides will be following the documentation project, we believe this is the case.
Project should not inadvertently duplicate functionality present in other OpenStack projects. If they do, they should have a clear plan and timeframe to prevent long-term scope duplication.
We are including existing documentation at build, so there is reuse rather than duplication.
Project should leverage existing functionality in other OpenStack projects as much as possible
See above.
Maturity
Project should have an active team of contributors
We are working on that. Right much of the work is being done outside of github. We will be fixing that over June.
Project should not have a major architectural rewrite planned
No major changes are planned.
Process
Project must be hosted under stackforge (and therefore use git as its VCS)
We are working this out with the documentation, infra, and TC. Right now the data is under the openstack-manuals repo.
Project must obey OpenStack coordinated project interface (such as tox, pbr, global-requirements...)
Not applicable
Project should use oslo libraries or oslo-incubator where appropriate
Not applicable
If project is not part of an existing program, it needs to file for a new program concurrently with the Incubation request, and fill the corresponding requirements.
Training-guides will be part of the Documentation program
Project must have a well-defined core review team, with reviews distributed amongst the team (and not being primarily done by one person)
Right now it is two people. We have spun out into five sub-projects. Each sub-project lead will be a core-reviewer at least. We should end up with 7-8 core reviewers over the entire project.
Reviews should follow the same criteria as OpenStack projects (2 +2s before +A)
Training-guides will follow the standard practice
Project should use the official openstack lists for discussion
We will push our ML discussions to docs ML. We already use IRC meetings.
API
Project APIs should be reasonably stable
Not applicable
Project must have a REST API with at least a JSON entity representation
Not applicable
Project must have a Python client library API for its REST API
Not applicable
QA
Project must have a basic devstack-gate job set up
TBD
Documentation / User support
Project must have docs for developers who want to contribute to the project
http://docs.openstack.org/training-guides/content/under-construction.html
Project should have API documentation for devs who want to add to the API, updated when the code is updated
Not applicable
Legal requirements
Project must be licensed under the Apache License v2
Licensed under Apache License v2 and Creative Commons Attribution ShareAlike 3.0 License as per the OpenStack documentation program projects lead.
Project must have no library dependencies which effectively restrict how the project may be distributed or deployed [1]
Content has no known dependencies
All contributors to the project must have signed the CLA
This is the case
Project must have no known trademark issues [2]
This is the case