[upstream] Remove content that exists in Contrib Guide

This patch removes the info that exists in the guide, leaving the
exercises behind to continue using them in the trainings.

Change-Id: I5f30f12ddd7afa0dca083eaf0256c31fa2889921
This commit is contained in:
Kendall Nelson 2018-03-15 17:11:33 -07:00
parent a56584bd3f
commit f10a3f6dd5
20 changed files with 16 additions and 347 deletions

Binary file not shown.

Before

Width:  |  Height:  |  Size: 130 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 73 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 37 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 16 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 22 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 22 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 54 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 19 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 54 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 6.4 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 13 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 95 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 9.9 KiB

View File

@ -9,82 +9,18 @@ Online Communication
.. note:: .. note::
Tags: [operator] [user] [new_dev] [dev] Tags: [operator] [user] [new_dev] [dev]
Ways to Communicate in OpenStack
================================
- Talking in IRC Channels & Meetings
- Wiki Pages
- Etherpads
- Mailing Lists
IRC Channels
============
- Project Channels:
- https://wiki.openstack.org/wiki/IRC
- Each project and working group has its own channel
- The common syntax: #openstack-<name-of-project>
- Meeting Channels:
- #openstack-meeting, #openstack-meeting-cp, etc.
- Meetings typically follow an agenda
- Most projects use the OpenStack wiki to post agendas
- IRC meetings: http://eavesdrop.openstack.org/
- Others: https://wiki.openstack.org/wiki/Meetings
.. note::
There are a finite number of meeting channels so that meetings are
spread around. This is enforced by infra. The #openstack-meeting-cp
channel is special in that it is dedicated to cross project efforts.
IRC Logs
========
- Logs of meetings and channels are archived so that they can be
referenced later on
- Meeting Logs: http://eavesdrop.openstack.org/meetings/
- Channel Logs: http://eavesdrop.openstack.org/irclogs/
Exercise 1 Exercise 1
========== ==========
Join the channel of the project(s) you are interested in and find the Join the channel of the project(s) you are interested in and find the
logs from the most recent meeting. logs from the most recent meeting.
Wiki Pages
==========
- Each project and working group also has its own wiki page
- https://wiki.openstack.org/wiki/Main_Page
- Good source of info about when and in what channel regular meetings are held
- Generally has information about who the PTL and cores are
Exercise 2 Exercise 2
========== ==========
Look up when the next meeting is for the channel you joined and where Look up when the next meeting is for the channel you joined and where
the meeting is conducted (#openstack-meeting, #openstack-meeting-3, etc). the meeting is conducted (#openstack-meeting, #openstack-meeting-3, etc).
Etherpads
=========
- Common place to have people in a project collaborate on larger projects
and planning of events
- No master list of etherpads - harder to find what you are looking for
without having looked at it before or without asking for the URL
- `https://etherpad.openstack.org <https://etherpad.openstack.org>`_
Mailing Lists (ML)
==================
- More than 40 different ML's
- http://lists.openstack.org/cgi-bin/mailman/listinfo
- Way for people to communicate to a larger group than those that
are on IRC
- All emails are archived
- The `Mailing Lists <https://wiki.openstack.org/wiki/Mailing_Lists>`_ wiki
page describes how to subscribe to a list and describes some popular lists
Exercise 3 Exercise 3
========== ==========

View File

@ -44,7 +44,6 @@ Workflow and Tools for Participation
workflow-training-contribution-process.rst workflow-training-contribution-process.rst
workflow-task-tracking.rst workflow-task-tracking.rst
workflow-gerrit.rst
workflow-reviewing.rst workflow-reviewing.rst
workflow-commit-message.rst workflow-commit-message.rst
workflow-project-status-and-zuul.rst workflow-project-status-and-zuul.rst

View File

@ -1,61 +0,0 @@
====================
review.openstack.org
====================
.. image:: ./_assets/os_background.png
:class: fill
:width: 100%
.. note::
Tags: [new_dev] [dev]
review.openstack.org
====================
.. image:: ./_assets/14-01-review.png
:width: 100%
:class: image-pad-top
gerrit workflow
===============
.. image:: ./_assets/14-02-gerrit-workflow.png
:width: 100%
:class: image-pad-top
upload an ssh key
=================
- https://review.openstack.org/#/settings/ssh-keys
.. image:: ./_assets/14-03-upload-ssh-key.png
:width: 85%
:class: image-pad-top
invite reviewers
================
.. image:: ./_assets/14-11-invite-reviewers.png
:width: 100%
:class: image-pad-top
gerrit patchset history
=======================
.. image:: ./_assets/14-15-patchset-history.png
:width: 100%
:class: image-pad-top
patchset diffs
==============
.. image:: ./_assets/14-17-patchset-diffs.png
:width: 100%
:class: image-pad-top
patch in gerrit
===============
.. image:: ./_assets/workflow-gerrit-merged-patch.png
:width: 100%
:class: image-pad-top

View File

@ -9,33 +9,6 @@ Reviewing
.. note:: .. note::
Tags: [new_dev] [dev] Tags: [new_dev] [dev]
Review unified
==============
.. image:: ./_assets/16-01-review-unified.png
:width: 100%
Inline comments
===============
.. image:: ./_assets/16-03-inline-comments.png
Draft inline comments
=====================
.. image:: ./_assets/16-04-draft-inline-comments.png
:width: 100%
Regular reviewer
================
.. image:: ./_assets/16-05-regular-reviewer.png
Core reviewer
=============
.. image:: ./_assets/16-06-core-reviewer.png
Exercise Exercise
======== ========
@ -46,23 +19,3 @@ https://docs.openstack.org/upstream-training/workflow-using-sandbox.html
Try to find things to make comments on even if they Try to find things to make comments on even if they
are just asking a question and not pointing out an are just asking a question and not pointing out an
issue, don't just +1 three different patches. issue, don't just +1 three different patches.
Work In Progress Patches
========================
.. image:: ./_assets/workflow-reviewing-wip-patch.png
Work In Progress Patches
========================
- Multiple ways a patch can be indicated as a Work In Progress
- 'Workflow' is set to '-1'
- '[WIP]' is at the beginning of the patch's summary line
- Developers often do this to share an early preview of what they are
doing or to allow for feedback during development
- Patches may be reviewed but should be done so with the fact that
the patch is still being developed in mind
- Don't -1 for spelling mistakes, wording or missing details

View File

@ -9,175 +9,14 @@ Setup & First Patch
.. note:: .. note::
Tags: [new_dev] Tags: [new_dev]
git config
==========
.. code-block:: console
$ git config --global user.name "Firstname Lastname"
$ git config --global user.email "your_email@youremail.com"
$ git config --list
user.email=your_email@youremail.com
user.name=Firstname Lastname
core.repositoryformatversion=0
core.filemode=true
core.bare=false
core.logallrefupdates=true
remote.origin.url=https://git.openstack.org/openstack/training-guides
remote.origin.fetch=+refs/heads/*:refs/remotes/origin/*
branch.master.remote=origin
branch.master.merge=refs/heads/master
Install git review
==================
- Use either your distribution's package manager (``apt``/``yum``) or ``pip``
(recommended)
.. code-block:: console
$ sudo -H pip install git-review
Collecting git-review
Downloading git_review-1.25.0-py2.py3-none-any.whl
[ ... ]
Installing collected packages: git-review
Successfully installed git-review-1.25.0
git clone
=========
.. code-block:: console
$ git clone git://git.openstack.org/openstack-dev/sandbox
Cloning into 'sandbox'...
remote: Counting objects: 1548, done.
remote: Compressing objects: 100% (1049/1049), done.
remote: Total 1548 (delta 598), reused 1178 (delta 340)
Receiving objects: 100% (1548/1548), 254.74 KiB | 70.00 KiB/s, done.
Resolving deltas: 100% (598/598), done.
$ cd sandbox/
git review -s
=============
.. code-block:: console
$ git review -s
The authenticity of host '[104.130.246.91]:29418 ([104.130.246.91]:29418)' can't be established.
RSA key fingerprint is SHA256:RXNl/GKyDaKiIQ93BoDvrNSKUPFvA1PNeAO9QiirYZU.
Are you sure you want to continue connecting (yes/no)? yes
Could not connect to gerrit.
Enter your gerrit username: USERNAME
Trying again with ssh://USERNAME@104.130.246.91:29418/openstack-dev/sandbox.git
Creating a git remote called "gerrit" that maps to:
ssh://USERNAME@104.130.246.91:29418/openstack-dev/sandbox.git
This repository is now set up for use with git-review. You can set the
default username for future repositories with:
git config --global --add gitreview.username "USERNAME"
$ git config --global --add gitreview.username "USERNAME"
git remote show gerrit
======================
.. code-block:: console
$ git remote show gerrit
* remote gerrit
Fetch URL: ssh://USERNAME@104.130.246.91:29418/openstack-dev/sandbox.git
Push URL: ssh://USERNAME@104.130.246.91:29418/openstack-dev/sandbox.git
HEAD branch: master
Remote branches:
feature/foo tracked
master tracked
merge-test tracked
stable/xyzzy tracked
Local ref configured for 'git push':
master pushes to master (up to date)
git checkout -b TOPIC-BRANCH
============================
.. code-block:: console
$ git checkout -b TOPIC-BRANCH
Switched to a new branch 'TOPIC-BRANCH'
$ git branch -vv
* TOPIC-BRANCH 33798d4 Imported Translations from Zanata
master 33798d4 [origin/master] Imported Translations from Zanata
running unit tests
==================
.. code-block:: console
$ tox -e py27,pep8
[ ... ]
======
Totals
======
Ran: 11720 tests in 686.0000 sec.
- Passed: 11712
- Skipped: 8
- Expected Fail: 0
- Unexpected Success: 0
- Failed: 0
Sum of execute time for each test: 2382.5781 sec.
==============
Worker Balance
==============
- Worker 0 (2929 tests) => 0:09:59.085214
- Worker 1 (2931 tests) => 0:10:51.072379
[ ... ]
git commit --amend
==================
.. code-block:: console
$ git commit --amend
.. image:: ./_assets/14-13-git-commit-amend.png
:height: 450px
:align: center
.. note:: .. note::
Without going into details, mention and explain what kind of tools are Step by step guides to help with the exercise exists in the contributor
available when it comes to diff, merge and edit commit messages in a portal: https://docs.openstack.org/contributors/code-and-documentation/
real-world scenario. Look at the 'Setup & Learn Git','Setting Up Your Gerrit Account', and
the 'Using Gerrit' sections for reference.
Worth mentioning: Exercise
- git gui ========
- gitk / gitg
- tig
- vim-fugitive, emacs-magit
- other graphical stand-alone tools (sourcetree, tortoisegit)
git review
==========
.. code-block:: console
$ git review
remote: Processing changes: updated: 1, refs: 1, done
remote: (W) f985de5: commit subject >65 characters; use shorter first paragraph
remote:
remote: Updated Changes:
remote: https://review.openstack.org/489760 WIP: Workflow - Replace inconsistent screenshots with selectable code snippets.
remote:
To ssh://review.openstack.org:29418/openstack/training-guides.git
* [new branch] HEAD -> refs/publish/master/workflow-replace-images
Exercise #1
===========
- Configure your workspace - Configure your workspace
- ``git config`` - ``git config``

View File

@ -22,13 +22,12 @@ How to prepare
* Read and complete the * Read and complete the
`Setup IRC <https://docs.openstack.org/contributors/common/irc.html>`_ `Setup IRC <https://docs.openstack.org/contributors/common/irc.html>`_
guide. guide.
* Read and complete the `Accounts <https://docs.openstack.org/contributors/common/accounts.html>`_ section of the Contributor Guide.
* Read and complete the
`Setup and Learn GIT <https://docs.openstack.org/contributors/common/git.html>`_
guide.
* Read and complete the `Account Setup <https://docs.openstack.org/contributors/common/accounts.html>`_ * Read and complete the `Account Setup <https://docs.openstack.org/contributors/common/accounts.html>`_
guide. (**Note:** you will need to sign the Individual Contributor License guide. (**Note:** you will need to sign the Individual Contributor License
Agreement (`ICLA <https://review.openstack.org/static/cla.html>`_) Agreement (`ICLA <https://review.openstack.org/static/cla.html>`_)
during this.) during this.)
.. note::
Aside from the Setup IRC section above, we will cover everything else that is in
`the Contributor Guide <https://docs.openstack.org/contributors/>`_ during the class.

View File

@ -8,6 +8,11 @@ OpenStack Upstream Institute Training Content
include additional explanation in the *Presenter notes* (press include additional explanation in the *Presenter notes* (press
:command:`c` to see them). :command:`c` to see them).
.. note::
Most of the course content is being moved to `the Contributor Guide
<https://docs.openstack.org/contributors/>`_. In the future, all
that will live here are exercises that accompany the Guide.
Introduction Introduction
------------ ------------
@ -35,7 +40,6 @@ Workflow and Tools for Participation
* `Overview of the contribution process * `Overview of the contribution process
<workflow-training-contribution-process.html>`_ <workflow-training-contribution-process.html>`_
* `Task Tracking <workflow-task-tracking.html>`_ * `Task Tracking <workflow-task-tracking.html>`_
* `Gerrit <workflow-gerrit.html>`_
* `Reviewing <workflow-reviewing.html>`_ * `Reviewing <workflow-reviewing.html>`_
* `Commit Messages <workflow-commit-message.html>`_ * `Commit Messages <workflow-commit-message.html>`_
* `Project Status and Zuul <workflow-project-status-and-zuul.html>`_ * `Project Status and Zuul <workflow-project-status-and-zuul.html>`_