Jump to: navigation, search

Difference between revisions of "OpenStack Upstream Training/Info"

(Replaced content with "=== New location of the Upstream materials === === Upstream training material is now published continuously at http://docs.openstack.org/upstream-training === Upstream m...")
 
(3 intermediate revisions by 2 users not shown)
Line 1: Line 1:
<translate>
+
=== New location of the Upstream materials ===
  
== Introduction == <!--T:1-->
+
=== Upstream training material is now published continuously at http://docs.openstack.org/upstream-training ===
  
<!--T:2-->
+
Upstream material is now converted into standard RST format. To update it please submit a patch for it in the [[Training-guides|Training guides]] repository (http://git.openstack.org/cgit/openstack/training-guides).
With over 2000 developers from 80 different companies worldwide, OpenStack is one of the largest collaborative software-development projects. Because of its size, it is characterized by a huge diversity in social norms and technical conventions.  These can significantly slow down the speed at which newcomers are successful at integrating their own roadmap into that of the OpenStack project.
 
 
 
<!--T:3-->
 
We've designed a training program to help professional developers negotiate this hurdle.  It shows them how to ensure their bug fix or feature is accepted in the OpenStack project in a minimum amount of time.  The educational program requires students to work on real-life bug fixes or new features during two days of real-life classes and online mentoring, until the work is accepted by OpenStack. The live two-day class teaches them to navigate the intricacies of the project's technical tools and social interactions. In a followup session, the students benefit from individual online sessions to help them resolve any remaining problems they might have.
 
 
 
== Objectives == <!--T:4-->
 
 
 
<!--T:5-->
 
* Faster integration of the companies product roadmap into the OpenStack release cycle
 
* Successfully contribute one real world patch to an OpenStack component
 
* Master the technical tools
 
* Understand the OpenStack contribution workflow and social norms
 
 
 
== Target Audience == <!--T:6-->
 
 
 
<!--T:7-->
 
* Developers
 
* System administrators
 
 
 
== Prerequisites == <!--T:8-->
 
 
 
<!--T:9-->
 
* Being able to read and write English at a technical level.
 
* If contributing code, being technically proficient enough to carry out simple bug fixes in the project.
 
* If contributing documentation, being able to produce documents in the project's chosen infrastructure.
 
* Having at least 8 hours a week to dedicate to the project, be it through programming or through interacting with the community.
 
 
 
== Duration == <!--T:10-->
 
 
 
<!--T:11-->
 
* Face-to-face section: 2 days
 
* Online section: 10 one-hour individual mentoring sessions over a period of 4 to 10 weeks
 
 
 
== Infrastructure == <!--T:12-->
 
 
 
<!--T:13-->
 
[[OpenStack_Upstream_Training/Setup_DevStack|ready to use devstack VM]] for participants with network connectivity but troubles with their laptop
 
 
 
= Course Outline = <!--T:14-->
 
 
 
== First day == <!--T:15-->
 
 
 
=== Introduction === <!--T:16-->
 
 
 
<!--T:17-->
 
* A week before Day 1: choice of a contribution, via email, with each participant
 
* Day 1: How OpenStack is made
 
* Day 1: Learn and practice git, gerrit, IRC
 
 
 
<!--T:18-->
 
* Day 2: The theory of contribution
 
* Day 2: Lego contribution simulation
 
* Day 2: Individual presentation of the contribution plan
 
* Day 2: Online mentoring
 
 
 
=== How OpenStack is made (3h including 1h30 exercises) === <!--T:19-->
 
 
 
<!--T:20-->
 
* [https://wiki.openstack.org/wiki/Release_Cycle Release cycle] ( [https://github.com/openstack/training-guides/blob/master/doc/upstream-training/source/01-release-cycle.rst slides] )
 
** [https://wiki.openstack.org/wiki/Release_Cycle#Planning_.28Design.2C_Discuss_and_Target.29 Planning (Design, Discuss and Target)]
 
** [https://wiki.openstack.org/wiki/Release_Cycle#Implementation_.28Milestone_iterations.29 Implementation (Milestone iterations)]
 
** [https://wiki.openstack.org/wiki/Release_Cycle#Pre-release_.28Release_Candidates_dance.29 Pre-release (Release Candidates dance)]
 
*** [https://wiki.openstack.org/wiki/Release_Cycle#Release_candidate_1 Release candidate 1]
 
*** [https://wiki.openstack.org/wiki/Release_Cycle#Other_release_candidates Other release candidates]
 
*** [https://wiki.openstack.org/wiki/Release_Cycle#Release_day Release day]
 
** Exercise: based on the [https://wiki.openstack.org/wiki/Kilo_Release_Schedule Kilo release schedule] find the URL of a document or a patch that belongs to each of the above steps.
 
* Relevant actors ( [https://github.com/openstack/training-guides/blob/master/doc/upstream-training/source/02-relevant-actors.rst slides] )
 
** [http://www.stackalytics.com/?release=kilo&metric=commits&project_type=integrated&module=&company=&user_id= commiters] companies
 
** [http://www.stackalytics.com/?release=kilo&metric=commits&project_type=integrated&module=&company=&user_id= commiters] individuals (bottom of the page)
 
** Your management
 
* [http://governance.openstack.org/ OpenStack Governance] ( [https://github.com/openstack/training-guides/blob/master/doc/upstream-training/source/03-technical-committee.rst slides] )
 
** [http://governance.openstack.org/reference/charter.html Technical Committee]
 
** The role of the [http://governance.openstack.org/reference/charter.html#mission Technical Committee]
 
** [http://governance.openstack.org/reference/charter.html#openstack-project-teams OpenStack Project Teams]
 
** [http://governance.openstack.org/reference/projects/index.html OpenStack Project Teams list]
 
** [https://wiki.openstack.org/wiki/Meetings#Technical_Committee_meeting Meetings]
 
** Exercise: read [http://eavesdrop.openstack.org/meetings/tc/2014/tc.2014-04-01-20.03.log.html archived] and briefly comment on [https://etherpad.openstack.org/p/keystone-incubation-integration-requirements keystone document]
 
** [http://governance.openstack.org/reference/charter.html#project-team-leads PTLs]
 
** [http://governance.openstack.org/reference/charter.html#voters-for-ptl-seats-apc APC]
 
** [http://governance.openstack.org/reference/charter.html#voters-for-tc-seats-atc ATC]
 
** Exercise: each APC / ATC in the class add a URL to the etherpad proving it
 
* [http://governance.openstack.org/reference/new-projects-requirements.html "Big Tent" and tags]  ( [https://github.com/openstack/training-guides/blob/master/doc/upstream-training/source/04-program-ecosystem.rst slides] )
 
** [http://governance.openstack.org/reference/projects/index.html OpenStack Project Teams]
 
** [http://governance.openstack.org/reference/tags/index.html List of approved tags]
 
** [https://github.com/openstack/defcore Understanding the DefCore Guidelines]
 
** [https://github.com/openstack/defcore/blob/master/process/CoreDefinition.rst Core Definition]
 
** [http://ci.openstack.org/stackforge.html Stackforge]
 
** [http://docs.openstack.org/infra/manual/creators.html How to add a project to Stackforge]
 
** Exercise: What kind of Program do you contribute to ?
 
* [https://wiki.openstack.org/wiki/Design_Summit Design summits]  ( [https://github.com/openstack/training-guides/blob/master/doc/upstream-training/source/05-design-summit.rst slides] )
 
** [https://wiki.openstack.org/wiki/Design_Summit/Planning Propose sessions]
 
** [https://libertydesignsummit.sched.org/overview/type/design+summit#.VVeYTt-uNNw List of sessions]
 
** [https://wiki.openstack.org/wiki/Design_Summit/Liberty/Etherpads Liberty Summit Etherpads]
 
** Exercise: Add a session proposal regarding your contribution in an etherpad, review two proposals
 
* [https://wiki.openstack.org/wiki/Meetings IRC meetings]  ( [https://github.com/openstack/training-guides/blob/master/doc/upstream-training/source/06-irc-meetings.rst slides] )
 
** [http://docs.openstack.org/infra/system-config/irc.html IRC Services]
 
** [http://wiki.debian.org/MeetBot meetbot]
 
** [https://wiki.openstack.org/wiki/IRC OpenStack IRC channels]
 
** [http://eavesdrop.openstack.org/irclogs/ IRC Logs]
 
** #info - Add an info item to the minutes. People should liberally use this for important things they say, so that they can be logged in the minutes.
 
** #action - Document an action item in the minutes. Include any nicknames in the line, and the item will be assigned to them. (nicknames are case-sensitive)
 
** #help - Add a "Call for Help" to the minutes. Use this command when you need to recruit someone to do a task. (Counter-intuitively, this doesn't provide help on the bot)
 
** Exercise: lunch menu online meeting
 
 
 
=== Workflow of an OpenStack contribution and tools (3h including 2h exercises) === <!--T:21-->
 
 
 
<!--T:22-->
 
* [http://devstack.org/ devstack] ( [https://github.com/openstack/training-guides/blob/master/doc/upstream-training/source/11-devstack.rst slides] )
 
** Ubuntu or Fedora
 
** git clone https://github.com/openstack-dev/devstack.git
 
** [http://devstack.org/configuration.html minimal configuration]
 
** cd devstack; ./stack.sh
 
** Exercise: get the code for the targeted contribution
 
* [[How_To_Contribute|HOW to contribute URL]] ( [https://github.com/openstack/training-guides/blob/master/doc/upstream-training/source/12-howtocontribute.rst slides] )
 
** [[Puppet-openstack#Contributing_to_the_modules|puppet stackforge]]
 
** [[Documentation/HowTo|documentation]]
 
** [http://docs.openstack.org/training-guides/content/under-construction.html training guides]
 
** Excercise: Apply for individual membership and sign the CLA
 
* [https://help.launchpad.net/ launchpad] ( [https://github.com/openstack/training-guides/blob/master/doc/upstream-training/source/13-launchpad.rst slides] )
 
** [[Blueprints|blueprints]]
 
** [[Bugs|bugs]]
 
*** [[Bugs#Bugs_reference|Status, Importance, Assigned To, Milestone, Tags]]
 
*** [[Bugs#Reporting|reporting a bug]]
 
*** [[Bugs#Confirming_.26_prioritizing|confirming and prioritizing]]
 
*** [[Bugs#Debugging_.28optional.29|debugging]]
 
*** [[Bugs#Bugfixing|bugfixing]]
 
** Exercise: review other launchpad bugs and improve yours
 
* [http://docs.openstack.org/infra/manual/developers.html Developer’s Guide] ( [https://github.com/openstack/training-guides/blob/master/doc/upstream-training/source/14-gerrit.rst slides] )
 
** [http://docs.openstack.org/infra/manual/developers.html#account-setup Account setup]
 
** [http://docs.openstack.org/infra/manual/developers.html#installing-git-review Git review installation]
 
** [http://docs.openstack.org/infra/manual/developers.html#starting-work-on-a-new-repository Starting Work on a New Repository]
 
** [http://docs.openstack.org/infra/manual/developers.html#development-workflow Development workflow]
 
** [http://docs.openstack.org/infra/manual/developers.html#running-unit-tests Running unit tests]
 
** [http://docs.openstack.org/infra/manual/developers.html#cross-repository-dependencies Cross-Repository Dependencies]
 
** Exercise: push a wip or draft and invite reviewers
 
* Branching model ( [https://github.com/openstack/training-guides/blob/master/doc/upstream-training/source/15-branching-model.rst slides] )
 
** [[BranchModel|development]]
 
** [[StableBranch|stable]]
 
** Exercise: checkout the latest stable branch
 
* [http://docs.openstack.org/infra/manual/developers.html#code-review Code Review]  ( [https://github.com/openstack/training-guides/blob/master/doc/upstream-training/source/16-reviewing.rst slides] )
 
* [http://docs.openstack.org/infra/manual/developers.html#peer-review Peer Review] ( [https://github.com/openstack/training-guides/blob/master/doc/upstream-training/source/17-commit-message.rst slides] )
 
** [https://wiki.openstack.org/wiki/GitCommitMessages Git Commit Good Practice]
 
** Gerrit Documentation: [https://review.openstack.org/Documentation/intro-quick.html Gerrit Code Review - A Quick Introduction]
 
** Gerrit Documentation: [https://review.openstack.org/Documentation/intro-quick.html#_reviewing_the_change Reviewing the Change]
 
** Exercise: review each other messages on the draft
 
* [http://docs.openstack.org/infra/manual/developers.html#automated-testing Jenkins (Automated Testing)]  ( [https://github.com/openstack/training-guides/blob/master/doc/upstream-training/source/18-jenkins.rst slides] )
 
** Exercise: add an error and match it to the jenkins message
 
 
 
== Second day == <!--T:23-->
 
 
 
=== The Contribution Process (1 hour) === <!--T:24-->
 
 
 
<!--T:25-->
 
( [https://github.com/openstack/training-guides/blob/master/doc/upstream-training/source/19-training-contribution-process.rst slides] )
 
* Take the pulse of the project.
 
* Figure out who's behind it.
 
* Determine the project's social groups.
 
* Assess your approach.
 
* Engage immediately.
 
* Play with your network.
 
* Perform the smaller tasks.
 
* Choose a question.
 
* Familiarize yourself with the code of conduct.
 
* Understand the conventions.
 
* Explain what you do.
 
* Prepare the backport.
 
* Learn what's local and what's upstream.
 
* Learn what distinguishes good work flow from bad work flow.
 
* Quantify the delta.
 
* Speed up the acceptance.
 
* Determine the time frame.
 
* Maximize karma.
 
* Work in parallel.
 
* Archive and collect.
 
 
 
=== Agile for Contributors (15 min) === <!--T:26-->
 
 
 
<!--T:27-->
 
( [https://github.com/openstack/training-guides/blob/master/doc/upstream-training/source/20-training-agile-for-contributors.rst slides] )
 
* Apply agile
 
* Who is the customer?
 
* Company & Upstream product owner
 
* Sprint review presentation to Upstream
 
 
 
=== Contribution Simulation (2 hour) === <!--T:28-->
 
 
 
<!--T:29-->
 
The students make a virtual contribution simulation using Lego bricks as props, with the goal of expanding a Lego town, built by upstream. They are divided into teams; the teacher is by turns the product owner in the company and the upstream.
 
 
 
=== Contribution Planning (2 hours) === <!--T:30-->
 
 
 
<!--T:31-->
 
( [http://dachary.org/loic/openstack-training/training-student-project-sample.odp odp slides] [http://dachary.org/loic/openstack-training/training-student-project-sample.pdf pdf slides] )
 
 
 
 
 
<!--T:32-->
 
* The students use template slides to prepare a 5-minute presentation of their planned contribution.
 
* A sample presentation is given by the teacher, as an example.
 
* Each student group prepares a presentation describing:
 
** the contribution they plan to work on during the online sessions,
 
** how they will engage with the Upstream,
 
** how it contributes to the company's agenda
 
** and whom they will be working with.
 
* Each student group presents its slides to the class
 
 
 
=== Etherpad === <!--T:33-->
 
 
 
<!--T:34-->
 
https://etherpad.openstack.org/p/upstream-training-vancouver
 
 
 
</translate>
 

Latest revision as of 13:33, 15 January 2016

New location of the Upstream materials

Upstream training material is now published continuously at http://docs.openstack.org/upstream-training

Upstream material is now converted into standard RST format. To update it please submit a patch for it in the Training guides repository (http://git.openstack.org/cgit/openstack/training-guides).