[Upstream-training] Move content from wiki to the RST 2
Move content from https://wiki.openstack.org/wiki/OpenStack_Upstream_Training/Info to the RST format. Change-Id: Ic4d6b638015a240341fc1664283650ac35fb8fc6
This commit is contained in:
Matjaz Pancur
parent
284a6ba560
commit
603a0abfe7
@ -22,6 +22,9 @@ 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.
|
||||
|
||||
|
||||
:doc:`upstream-details`
|
||||
|
||||
When & Where to get OpenStack Upstream Training
|
||||
===============================================
|
||||
|
||||
|
||||
299
doc/upstream-training/upstream-details.rst
Normal file
299
doc/upstream-training/upstream-details.rst
Normal file
@ -0,0 +1,299 @@
|
||||
===================================
|
||||
OpenStack Upstream Training Details
|
||||
===================================
|
||||
|
||||
Introduction
|
||||
============
|
||||
|
||||
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.
|
||||
|
||||
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
|
||||
==========
|
||||
|
||||
- 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
|
||||
===============
|
||||
|
||||
- Developers
|
||||
- System administrators
|
||||
|
||||
Prerequisites
|
||||
=============
|
||||
|
||||
- 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
|
||||
========
|
||||
|
||||
- Face-to-face section: 2 days
|
||||
- Online section: 10 one-hour individual mentoring sessions over a period of
|
||||
4 to 10 weeks
|
||||
|
||||
Infrastructure
|
||||
==============
|
||||
|
||||
- `ready to use devstack VM <https://wiki.openstack.org/wiki/OpenStack_Upstream_Training/Setup_DevStack>`_
|
||||
for participants with network connectivity but troubles with their laptop
|
||||
|
||||
Course Outline
|
||||
==============
|
||||
|
||||
First day
|
||||
=========
|
||||
|
||||
Introduction
|
||||
~~~~~~~~~~~~
|
||||
|
||||
* 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
|
||||
|
||||
* 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)
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
* `Release cycle <https://wiki.openstack.org/wiki/Release_Cycle>`_
|
||||
(`slides <01-release-cycle.html>`__)
|
||||
|
||||
* `Planning (Design, Discuss and Target) <https://wiki.openstack.org/wiki/Release_Cycle#Planning_.28Design.2C_Discuss_and_Target.29>`_
|
||||
* `Implementation (Milestone iterations <https://wiki.openstack.org/wiki/Release_Cycle#Implementation_.28Milestone_iterations.29>`_
|
||||
* `Pre-release (Release Candidates dance) <https://wiki.openstack.org/wiki/Release_Cycle#Pre-release_.28Release_Candidates_dance.29>`_
|
||||
|
||||
* `Release candidate 1 <https://wiki.openstack.org/wiki/Release_Cycle#Release_candidate_1>`_
|
||||
* `Other release candidates <https://wiki.openstack.org/wiki/Release_Cycle#Other_release_candidates>`_
|
||||
* `Release day <https://wiki.openstack.org/wiki/Release_Cycle#Release_day>`_
|
||||
|
||||
* Exercise: based on the `Kilo release schedule <https://wiki.openstack.org/wiki/Kilo_Release_Schedule>`_
|
||||
find the URL of a document or a patch that belongs to each of the above
|
||||
steps.
|
||||
|
||||
* Relevant actors (`slides <02-relevant-actors.html>`__)
|
||||
|
||||
* `commiters <http://www.stackalytics.com/?release=kilo&metric=commits&project_type=integrated&module=&company=&user_id=>`_
|
||||
companies
|
||||
* `commiters <http://www.stackalytics.com/?release=kilo&metric=commits&project_type=integrated&module=&company=&user_id=>`_
|
||||
individuals (bottom of the page)
|
||||
* Your management
|
||||
|
||||
* `OpenStack Governance <http://governance.openstack.org/>`_
|
||||
(`slides <03-technical-committee.html>`__)
|
||||
|
||||
* `Technical Committee <http://governance.openstack.org/reference/charter.html>`_
|
||||
* `The role of the Technical Committee <http://governance.openstack.org/reference/charter.html#mission>`_
|
||||
* `OpenStack Project Teams <http://governance.openstack.org/reference/charter.html#openstack-project-teams>`_
|
||||
* `OpenStack Project Teams list <http://governance.openstack.org/reference/projects/index.html>`_
|
||||
* `Meetings <https://wiki.openstack.org/wiki/Meetings#Technical_Committee_meeting>`_
|
||||
* Exercise: read `archived <http://eavesdrop.openstack.org/meetings/tc/2014/tc.2014-04-01-20.03.log.html>`_
|
||||
and briefly comment on `keystone document <https://etherpad.openstack.org/p/keystone-incubation-integration-requirements>`_
|
||||
* `PTLs <http://governance.openstack.org/reference/charter.html#project-team-leads>`_
|
||||
* `APC <http://governance.openstack.org/reference/charter.html#voters-for-ptl-seats-apc>`_
|
||||
* `ATC <http://governance.openstack.org/reference/charter.html#voters-for-tc-seats-atc>`_
|
||||
* Exercise: each APC / ATC in the class add a URL to the etherpad proving it
|
||||
|
||||
* `"Big Tent" and tags <http://governance.openstack.org/reference/new-projects-requirements.html>`_
|
||||
(`slides <04-program-ecosystem.html>`__)
|
||||
|
||||
* `OpenStack Project Teams <http://governance.openstack.org/reference/projects/index.html>`__
|
||||
* `List of approved tags <http://governance.openstack.org/reference/tags/index.html>`_
|
||||
* `Understanding the DefCore Guidelines <https://github.com/openstack/defcore>`_
|
||||
* `Core Definition <https://github.com/openstack/defcore/blob/master/process/CoreDefinition.rst>`_
|
||||
* `Stackforge <http://ci.openstack.org/stackforge.html>`_
|
||||
* `How to add a project to Stackforge <http://docs.openstack.org/infra/manual/creators.html>`_
|
||||
* Exercise: What kind of Program do you contribute to ?
|
||||
|
||||
* `Design summits <https://wiki.openstack.org/wiki/Design_Summit>`_
|
||||
(`slides <05-design-summit.html>`__)
|
||||
|
||||
* `Propose sessions <https://wiki.openstack.org/wiki/Design_Summit/Planning>`_
|
||||
* `List of sessions <https://libertydesignsummit.sched.org/overview/type/design+summit#.VVeYTt-uNNw>`_
|
||||
* `Liberty Summit Etherpads <https://wiki.openstack.org/wiki/Design_Summit/Liberty/Etherpads>`_
|
||||
* Exercise: Add a session proposal regarding your contribution in an
|
||||
etherpad, review two proposals
|
||||
|
||||
* `IRC meetings <https://wiki.openstack.org/wiki/Meetings>`_
|
||||
(`slides <06-irc-meetings.html>`__)
|
||||
|
||||
* `IRC Services <http://docs.openstack.org/infra/system-config/irc.html>`_
|
||||
* `meetbot <http://wiki.debian.org/MeetBot>`_
|
||||
* `OpenStack IRC channels <https://wiki.openstack.org/wiki/IRC>`_
|
||||
* `IRC Logs <http://eavesdrop.openstack.org/irclogs/>`_
|
||||
* ``#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)
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
* `devstack <http://docs.openstack.org/developer/devstack/>`_
|
||||
(`slides <11-devstack.html>`__)
|
||||
|
||||
* Ubuntu or Fedora
|
||||
* ``git clone https://github.com/openstack-dev/devstack.git``
|
||||
* `minimal configuration <http://docs.openstack.org/developer/devstack/configuration.html#minimal-configuration>`_
|
||||
* ``cd devstack; ./stack.sh``
|
||||
* Exercise: get the code for the targeted contribution
|
||||
|
||||
* `How_To_Contribute URL <https://wiki.openstack.org/wiki/How_To_Contribute>`_
|
||||
(`slides <12-howtocontribute.html>`__)
|
||||
|
||||
* `Puppet <https://wiki.openstack.org/wiki/Puppet#Contributing_to_the_modules>`_
|
||||
* `Documentation <https://wiki.openstack.org/wiki/Documentation/HowTo>`_
|
||||
* `Training guides <https://wiki.openstack.org/wiki/Training-guides#How_To>`_
|
||||
* Excercise: Apply for individual membership and sign the CLA
|
||||
|
||||
* `Launchpad <https://help.launchpad.net/>`_ (`slides <13-launchpad.html>`__)
|
||||
|
||||
* `Blueprints <https://wiki.openstack.org/wiki/Blueprints>`_
|
||||
* `Bugs <https://wiki.openstack.org/wiki/Bugs>`_
|
||||
|
||||
* `Status, Importance, Assigned To, Milestone, Tags <https://wiki.openstack.org/wiki/Bugs#Bugs_reference>`_
|
||||
* `reporting a bug <https://wiki.openstack.org/wiki/Bugs#Reporting>`_
|
||||
* `confirming and prioritizing <https://wiki.openstack.org/wiki/Bugs#Confirming_.26_prioritizing>`_
|
||||
* `debugging <https://wiki.openstack.org/wiki/Bugs#Debugging_.28optional.29>`_
|
||||
* `bugfixing <https://wiki.openstack.org/wiki/Bugs#Bugfixing>`_
|
||||
|
||||
* Exercise: review other launchpad bugs and improve yours
|
||||
|
||||
* How to contribute
|
||||
(`slides <14-gerrit.html>`__)
|
||||
|
||||
* `Developer’s Guide <http://docs.openstack.org/infra/manual/developers.html>`_
|
||||
* `Account setup <http://docs.openstack.org/infra/manual/developers.html#account-setup>`_
|
||||
* `Git review installation <http://docs.openstack.org/infra/manual/developers.html#installing-git-review>`_
|
||||
* `Starting Work on a New Repository <http://docs.openstack.org/infra/manual/developers.html#starting-work-on-a-new-repository>`_
|
||||
* `Development workflow <http://docs.openstack.org/infra/manual/developers.html#development-workflow>`_
|
||||
* `Running unit tests <http://docs.openstack.org/infra/manual/developers.html#running-unit-tests>`_
|
||||
* `Cross-Repository Dependencies <http://docs.openstack.org/infra/manual/developers.html#cross-repository-dependencies>`_
|
||||
* Exercise: push a wip or draft and invite reviewers
|
||||
|
||||
* Branching model
|
||||
(`slides <15-branching-model.html>`__)
|
||||
|
||||
* `Branch model <https://wiki.openstack.org/wiki/Branch_Model>`_
|
||||
* `Stable branch <https://wiki.openstack.org/wiki/StableBranch>`_
|
||||
* Exercise: checkout the latest stable branch
|
||||
|
||||
* `Code Review <http://docs.openstack.org/infra/manual/developers.html#code-review>`_
|
||||
(`slides <16-reviewing.html>`__)
|
||||
* `Peer Review <http://docs.openstack.org/infra/manual/developers.html#peer-review>`_
|
||||
(`slides <17-commit-message.html>`__)
|
||||
|
||||
* `Git Commit Good Practice <https://wiki.openstack.org/wiki/GitCommitMessages>`_
|
||||
* Gerrit Documentation: `Gerrit Code Review - A Quick Introduction <https://review.openstack.org/Documentation/intro-quick.html>`_
|
||||
* Gerrit Documentation: `Reviewing the Change <https://review.openstack.org/Documentation/intro-quick.html#_reviewing_the_change>`_
|
||||
* Exercise: review each other messages on the draft
|
||||
|
||||
* `Jenkins (Automated testing) <http://docs.openstack.org/infra/manual/developers.html#automated-testing>`_
|
||||
(`slides <18-jenkins.html>`__)
|
||||
|
||||
* Exercise: add an error and match it to the jenkins message
|
||||
|
||||
Second day
|
||||
==========
|
||||
|
||||
The Contribution Process (1 hour)
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
Overview of the contribution process
|
||||
(`slides <19-training-contribution-process.html>`__)
|
||||
|
||||
* 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)
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
Lego applied to Free Software contributions
|
||||
(`slides <20-training-agile-for-contributors.html>`__)
|
||||
|
||||
* Apply agile
|
||||
* Who is the customer?
|
||||
* Company & Upstream product owner
|
||||
* Sprint review presentation to Upstream
|
||||
|
||||
Contribution Simulation (2 hour)
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
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)
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
`ODP slides <http://dachary.org/loic/openstack-training/training-student-project-sample.odp>`_
|
||||
`PDF slides <http://dachary.org/loic/openstack-training/training-student-project-sample.pdf>`_
|
||||
|
||||
* 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
|
||||
~~~~~~~~
|
||||
|
||||
https://etherpad.openstack.org/p/upstream-training-vancouver
|
||||
|
||||
`Complete index in slide format only <http://docs.openstack.org/upstream-training/slide-index.html>`_
|
||||
6
tox.ini
6
tox.ini
@ -63,7 +63,7 @@ commands =
|
||||
# Build upstream-training slides
|
||||
sphinx-build -b slides doc/upstream-training/source/ doc/upstream-training/build/slides
|
||||
# Build upstream landing page index.html
|
||||
sphinx-build -b html doc/upstream-training doc/upstream-training/build/slides doc/upstream-training/index.rst
|
||||
sphinx-build -b html doc/upstream-training doc/upstream-training/build/slides doc/upstream-training/index.rst doc/upstream-training/upstream-details.rst
|
||||
# Build training-guides slides
|
||||
sphinx-build -b slides doc/training-guides/associate-guide/ doc/training-guides/associate-guide/build/slides
|
||||
# Publish as draft
|
||||
@ -77,7 +77,7 @@ commands =
|
||||
# Build upstream-training slides
|
||||
sphinx-build -b slides doc/upstream-training/source/ doc/upstream-training/build/slides
|
||||
# Build upstream landing page index.html
|
||||
sphinx-build -b html doc/upstream-training doc/upstream-training/build/slides doc/upstream-training/index.rst
|
||||
sphinx-build -b html doc/upstream-training doc/upstream-training/build/slides doc/upstream-training/index.rst doc/upstream-training/upstream-details.rst
|
||||
# Build training-guides slides
|
||||
sphinx-build -b slides doc/training-guides/associate-guide/ doc/training-guides/associate-guide/build/slides
|
||||
# Publish as draft
|
||||
@ -94,7 +94,7 @@ commands =
|
||||
# Build upstream-training slides
|
||||
sphinx-build -b slides doc/upstream-training/source/ doc/upstream-training/build/slides
|
||||
# Build upstream landing page index.html
|
||||
sphinx-build -b html doc/upstream-training doc/upstream-training/build/slides doc/upstream-training/index.rst
|
||||
sphinx-build -b html doc/upstream-training doc/upstream-training/build/slides doc/upstream-training/index.rst doc/upstream-training/upstream-details.rst
|
||||
|
||||
[testenv:training-slides]
|
||||
commands =
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user