diff --git a/doc/upstream-training/source/slides/_assets/sandbox-bug-reporter-review.png b/doc/upstream-training/source/slides/_assets/sandbox-bug-reporter-review.png new file mode 100644 index 00000000..0e6fa356 Binary files /dev/null and b/doc/upstream-training/source/slides/_assets/sandbox-bug-reporter-review.png differ diff --git a/doc/upstream-training/source/slides/_assets/sandbox-committer-amending.png b/doc/upstream-training/source/slides/_assets/sandbox-committer-amending.png new file mode 100644 index 00000000..ec715364 Binary files /dev/null and b/doc/upstream-training/source/slides/_assets/sandbox-committer-amending.png differ diff --git a/doc/upstream-training/source/slides/_assets/sandbox-committer-checking.png b/doc/upstream-training/source/slides/_assets/sandbox-committer-checking.png new file mode 100644 index 00000000..142b53a4 Binary files /dev/null and b/doc/upstream-training/source/slides/_assets/sandbox-committer-checking.png differ diff --git a/doc/upstream-training/source/slides/_assets/sandbox-committer-git-review-again.png b/doc/upstream-training/source/slides/_assets/sandbox-committer-git-review-again.png new file mode 100644 index 00000000..e3d22dcb Binary files /dev/null and b/doc/upstream-training/source/slides/_assets/sandbox-committer-git-review-again.png differ diff --git a/doc/upstream-training/source/slides/_assets/sandbox-committer-revise.png b/doc/upstream-training/source/slides/_assets/sandbox-committer-revise.png new file mode 100644 index 00000000..b5200f3d Binary files /dev/null and b/doc/upstream-training/source/slides/_assets/sandbox-committer-revise.png differ diff --git a/doc/upstream-training/source/slides/_assets/sandbox-core-reviewer-score.png b/doc/upstream-training/source/slides/_assets/sandbox-core-reviewer-score.png new file mode 100644 index 00000000..8d9497fd Binary files /dev/null and b/doc/upstream-training/source/slides/_assets/sandbox-core-reviewer-score.png differ diff --git a/doc/upstream-training/source/slides/_assets/sandbox-gerrit-add-reviewer-added.png b/doc/upstream-training/source/slides/_assets/sandbox-gerrit-add-reviewer-added.png new file mode 100644 index 00000000..9a0c7188 Binary files /dev/null and b/doc/upstream-training/source/slides/_assets/sandbox-gerrit-add-reviewer-added.png differ diff --git a/doc/upstream-training/source/slides/_assets/sandbox-gerrit-add-reviewer.png b/doc/upstream-training/source/slides/_assets/sandbox-gerrit-add-reviewer.png new file mode 100644 index 00000000..feb79b0e Binary files /dev/null and b/doc/upstream-training/source/slides/_assets/sandbox-gerrit-add-reviewer.png differ diff --git a/doc/upstream-training/source/slides/_assets/sandbox-gerrit-another-patchset.png b/doc/upstream-training/source/slides/_assets/sandbox-gerrit-another-patchset.png new file mode 100644 index 00000000..598180b6 Binary files /dev/null and b/doc/upstream-training/source/slides/_assets/sandbox-gerrit-another-patchset.png differ diff --git a/doc/upstream-training/source/slides/_assets/sandbox-gerrit-checking-comment-answer.png b/doc/upstream-training/source/slides/_assets/sandbox-gerrit-checking-comment-answer.png new file mode 100644 index 00000000..7212d0a6 Binary files /dev/null and b/doc/upstream-training/source/slides/_assets/sandbox-gerrit-checking-comment-answer.png differ diff --git a/doc/upstream-training/source/slides/_assets/sandbox-gerrit-checking-comment.png b/doc/upstream-training/source/slides/_assets/sandbox-gerrit-checking-comment.png new file mode 100644 index 00000000..2718bd7c Binary files /dev/null and b/doc/upstream-training/source/slides/_assets/sandbox-gerrit-checking-comment.png differ diff --git a/doc/upstream-training/source/slides/_assets/sandbox-gerrit-click-file.png b/doc/upstream-training/source/slides/_assets/sandbox-gerrit-click-file.png new file mode 100644 index 00000000..2ca3da25 Binary files /dev/null and b/doc/upstream-training/source/slides/_assets/sandbox-gerrit-click-file.png differ diff --git a/doc/upstream-training/source/slides/_assets/sandbox-gerrit-comment-publish-result.png b/doc/upstream-training/source/slides/_assets/sandbox-gerrit-comment-publish-result.png new file mode 100644 index 00000000..c1aaecf2 Binary files /dev/null and b/doc/upstream-training/source/slides/_assets/sandbox-gerrit-comment-publish-result.png differ diff --git a/doc/upstream-training/source/slides/_assets/sandbox-gerrit-merged.png b/doc/upstream-training/source/slides/_assets/sandbox-gerrit-merged.png new file mode 100644 index 00000000..3f537b23 Binary files /dev/null and b/doc/upstream-training/source/slides/_assets/sandbox-gerrit-merged.png differ diff --git a/doc/upstream-training/source/slides/_assets/sandbox-gerrit-patchsets.png b/doc/upstream-training/source/slides/_assets/sandbox-gerrit-patchsets.png new file mode 100644 index 00000000..4a3e1c32 Binary files /dev/null and b/doc/upstream-training/source/slides/_assets/sandbox-gerrit-patchsets.png differ diff --git a/doc/upstream-training/source/slides/_assets/sandbox-gerrit-publish-comment.png b/doc/upstream-training/source/slides/_assets/sandbox-gerrit-publish-comment.png new file mode 100644 index 00000000..d1f4049b Binary files /dev/null and b/doc/upstream-training/source/slides/_assets/sandbox-gerrit-publish-comment.png differ diff --git a/doc/upstream-training/source/slides/_assets/sandbox-gerrit-still-draft-comment.png b/doc/upstream-training/source/slides/_assets/sandbox-gerrit-still-draft-comment.png new file mode 100644 index 00000000..607fa00c Binary files /dev/null and b/doc/upstream-training/source/slides/_assets/sandbox-gerrit-still-draft-comment.png differ diff --git a/doc/upstream-training/source/slides/_assets/sandbox-gerrit-submission.png b/doc/upstream-training/source/slides/_assets/sandbox-gerrit-submission.png new file mode 100644 index 00000000..5d75596d Binary files /dev/null and b/doc/upstream-training/source/slides/_assets/sandbox-gerrit-submission.png differ diff --git a/doc/upstream-training/source/slides/_assets/sandbox-git-checkout-branch.png b/doc/upstream-training/source/slides/_assets/sandbox-git-checkout-branch.png new file mode 100644 index 00000000..d28ca667 Binary files /dev/null and b/doc/upstream-training/source/slides/_assets/sandbox-git-checkout-branch.png differ diff --git a/doc/upstream-training/source/slides/_assets/sandbox-git-commit-message.png b/doc/upstream-training/source/slides/_assets/sandbox-git-commit-message.png new file mode 100644 index 00000000..db78faae Binary files /dev/null and b/doc/upstream-training/source/slides/_assets/sandbox-git-commit-message.png differ diff --git a/doc/upstream-training/source/slides/_assets/sandbox-git-log.png b/doc/upstream-training/source/slides/_assets/sandbox-git-log.png new file mode 100644 index 00000000..65d4dbcb Binary files /dev/null and b/doc/upstream-training/source/slides/_assets/sandbox-git-log.png differ diff --git a/doc/upstream-training/source/slides/_assets/sandbox-git-new-file.png b/doc/upstream-training/source/slides/_assets/sandbox-git-new-file.png new file mode 100644 index 00000000..d0d85902 Binary files /dev/null and b/doc/upstream-training/source/slides/_assets/sandbox-git-new-file.png differ diff --git a/doc/upstream-training/source/slides/_assets/sandbox-git-repo-website.png b/doc/upstream-training/source/slides/_assets/sandbox-git-repo-website.png new file mode 100644 index 00000000..3e903253 Binary files /dev/null and b/doc/upstream-training/source/slides/_assets/sandbox-git-repo-website.png differ diff --git a/doc/upstream-training/source/slides/_assets/sandbox-git-review.png b/doc/upstream-training/source/slides/_assets/sandbox-git-review.png new file mode 100644 index 00000000..54127476 Binary files /dev/null and b/doc/upstream-training/source/slides/_assets/sandbox-git-review.png differ diff --git a/doc/upstream-training/source/slides/_assets/sandbox-git-status.png b/doc/upstream-training/source/slides/_assets/sandbox-git-status.png new file mode 100644 index 00000000..4f3f00d9 Binary files /dev/null and b/doc/upstream-training/source/slides/_assets/sandbox-git-status.png differ diff --git a/doc/upstream-training/source/slides/_assets/sandbox-list-bugs.png b/doc/upstream-training/source/slides/_assets/sandbox-list-bugs.png new file mode 100644 index 00000000..3006a7eb Binary files /dev/null and b/doc/upstream-training/source/slides/_assets/sandbox-list-bugs.png differ diff --git a/doc/upstream-training/source/slides/_assets/sandbox-lp-assign.png b/doc/upstream-training/source/slides/_assets/sandbox-lp-assign.png new file mode 100644 index 00000000..88aa3cd8 Binary files /dev/null and b/doc/upstream-training/source/slides/_assets/sandbox-lp-assign.png differ diff --git a/doc/upstream-training/source/slides/_assets/sandbox-lp-assignnee-changed.png b/doc/upstream-training/source/slides/_assets/sandbox-lp-assignnee-changed.png new file mode 100644 index 00000000..b8f32d7a Binary files /dev/null and b/doc/upstream-training/source/slides/_assets/sandbox-lp-assignnee-changed.png differ diff --git a/doc/upstream-training/source/slides/_assets/sandbox-lp-message-added.png b/doc/upstream-training/source/slides/_assets/sandbox-lp-message-added.png new file mode 100644 index 00000000..c1f2860a Binary files /dev/null and b/doc/upstream-training/source/slides/_assets/sandbox-lp-message-added.png differ diff --git a/doc/upstream-training/source/slides/_assets/sandbox-lp-website.png b/doc/upstream-training/source/slides/_assets/sandbox-lp-website.png new file mode 100644 index 00000000..c53fc3bf Binary files /dev/null and b/doc/upstream-training/source/slides/_assets/sandbox-lp-website.png differ diff --git a/doc/upstream-training/source/slides/_assets/sandbox-report-a-bug-details.png b/doc/upstream-training/source/slides/_assets/sandbox-report-a-bug-details.png new file mode 100644 index 00000000..9d945df9 Binary files /dev/null and b/doc/upstream-training/source/slides/_assets/sandbox-report-a-bug-details.png differ diff --git a/doc/upstream-training/source/slides/_assets/sandbox-report-a-bug-submission.png b/doc/upstream-training/source/slides/_assets/sandbox-report-a-bug-submission.png new file mode 100644 index 00000000..f6993007 Binary files /dev/null and b/doc/upstream-training/source/slides/_assets/sandbox-report-a-bug-submission.png differ diff --git a/doc/upstream-training/source/slides/_assets/sandbox-report-a-bug-summary.png b/doc/upstream-training/source/slides/_assets/sandbox-report-a-bug-summary.png new file mode 100644 index 00000000..97f3d3e2 Binary files /dev/null and b/doc/upstream-training/source/slides/_assets/sandbox-report-a-bug-summary.png differ diff --git a/doc/upstream-training/source/slides/_assets/sandbox-review-invitation.png b/doc/upstream-training/source/slides/_assets/sandbox-review-invitation.png new file mode 100644 index 00000000..4e3aeb03 Binary files /dev/null and b/doc/upstream-training/source/slides/_assets/sandbox-review-invitation.png differ diff --git a/doc/upstream-training/source/slides/_assets/sandbox-reviewer-comment-results.png b/doc/upstream-training/source/slides/_assets/sandbox-reviewer-comment-results.png new file mode 100644 index 00000000..5167cb69 Binary files /dev/null and b/doc/upstream-training/source/slides/_assets/sandbox-reviewer-comment-results.png differ diff --git a/doc/upstream-training/source/slides/_assets/sandbox-reviewer-comment.png b/doc/upstream-training/source/slides/_assets/sandbox-reviewer-comment.png new file mode 100644 index 00000000..30a903ee Binary files /dev/null and b/doc/upstream-training/source/slides/_assets/sandbox-reviewer-comment.png differ diff --git a/doc/upstream-training/source/slides/_assets/sandbox-reviewer-commenting.png b/doc/upstream-training/source/slides/_assets/sandbox-reviewer-commenting.png new file mode 100644 index 00000000..6dd5451b Binary files /dev/null and b/doc/upstream-training/source/slides/_assets/sandbox-reviewer-commenting.png differ diff --git a/doc/upstream-training/source/slides/_assets/sandbox-reviewer-publish-comment.png b/doc/upstream-training/source/slides/_assets/sandbox-reviewer-publish-comment.png new file mode 100644 index 00000000..fec27449 Binary files /dev/null and b/doc/upstream-training/source/slides/_assets/sandbox-reviewer-publish-comment.png differ diff --git a/doc/upstream-training/source/slides/_assets/sandbox-reviewer-scoring.png b/doc/upstream-training/source/slides/_assets/sandbox-reviewer-scoring.png new file mode 100644 index 00000000..07006279 Binary files /dev/null and b/doc/upstream-training/source/slides/_assets/sandbox-reviewer-scoring.png differ diff --git a/doc/upstream-training/source/slides/_assets/sandbox-scores.png b/doc/upstream-training/source/slides/_assets/sandbox-scores.png new file mode 100644 index 00000000..bfa3d1b4 Binary files /dev/null and b/doc/upstream-training/source/slides/_assets/sandbox-scores.png differ diff --git a/doc/upstream-training/source/slides/slide-index.rst b/doc/upstream-training/source/slides/slide-index.rst index 490cbe63..4eb9fdd5 100644 --- a/doc/upstream-training/source/slides/slide-index.rst +++ b/doc/upstream-training/source/slides/slide-index.rst @@ -32,7 +32,7 @@ How OpenStack is Made branching-model.rst Workflow and Tools for Participation -=============================================== +==================================== .. toctree:: :maxdepth: 1 @@ -45,6 +45,7 @@ Workflow and Tools for Participation workflow-commit-message.rst workflow-jenkins.rst workflow-setup-and-first-patch.rst + workflow-using-sandbox.rst Code Deep Dive ============== diff --git a/doc/upstream-training/source/slides/workflow-using-sandbox.rst b/doc/upstream-training/source/slides/workflow-using-sandbox.rst new file mode 100644 index 00000000..71f92e8b --- /dev/null +++ b/doc/upstream-training/source/slides/workflow-using-sandbox.rst @@ -0,0 +1,413 @@ +========================== +Using Sandbox for Practice +========================== + +.. image:: ./_assets/os_background.png + :class: fill + :width: 100% + +Sandbox repository +================== + +- OpenStack has a sandbox repository for learning and testing purposes +- Great repository to begin your OpenStack learning + + - https://git.openstack.org/cgit/openstack-dev/sandbox + +.. image:: ./_assets/sandbox-git-repo-website.png + :width: 95% + :align: center + +Sandbox Launchpad +================= + +- To manage and track the reported bugs and issues related with + openstack-dev/sandbox repository + + - https://launchpad.net/openstack-dev-sandbox + +.. image:: ./_assets/sandbox-lp-website.png + :width: 95% + :align: center + +Learning example with two Sandboxes +=================================== + +- Using Sandbox repository and Launchpad, next number of slides will show + the following steps: + + - Reporting a bug on Launchpad + - Reading the bug description and assigning her/himself to fix the bug + - Uploading a patch and inviting a peer as a reviewer + - Reviewing the patch and giving feedback with comment + - Uploading a revised patch with comment + - Reviewing the revised patch and merging the patch + + .. note:: + - Try to emphazise the synergy of using repository integration + with bug management to students! + +Sandbox Launchpad Bug list +========================== + +- https://bugs.launchpad.net/openstack-dev-sandbox + +.. image:: ./_assets/sandbox-list-bugs.png + :width: 80% + :align: center + +Report a bug - Summary +====================== + +- We have seen in `Overview of the contribution process + <workflow-training-contribution-process.html#4>`_ +- https://bugs.launchpad.net/openstack-dev-sandbox/+filebug + +.. image:: ./_assets/sandbox-report-a-bug-summary.png + :width: 80% + :align: center + +Report a bug - Details +====================== + +- (Real bug report needs detail descriptions.) + +.. image:: ./_assets/sandbox-report-a-bug-details.png + :width: 80% + :align: center + +Bug Report Submission +===================== + +- Successful bug report submission + +.. image:: ./_assets/sandbox-report-a-bug-submission.png + :width: 80% + :align: center + +Bug Assigning +============= + +- To notify working status on the bug to others + +.. image:: ./_assets/sandbox-lp-assign.png + :width: 80% + :align: center + +Bug Assigned +============ + +- (Other people will think that someone working on the bug.) + +.. image:: ./_assets/sandbox-lp-assignnee-changed.png + :width: 80% + :align: center + +Local branch creation +===================== + +- We have seen in `Overview of the contribution process + <workflow-training-contribution-process.html#5>`__ + and `Setup & First patch <workflow-setup-and-first-patch.html#8>`__ + +.. code-block:: console + + $ git checkout -b [BRANCH_NAME] + +.. image:: ./_assets/sandbox-git-checkout-branch.png + :width: 80% + :align: center + +Working for commit +================== + +- (As an example, a new file has been created using cat command.) + +.. image:: ./_assets/sandbox-git-new-file.png + :width: 80% + :align: center + +Checking work status +==================== + +- Current branch name information +- File status working in the repository + +.. code-block:: console + + $ git status + +.. image:: ./_assets/sandbox-git-status.png + :width: 80% + :align: center + +Add the file and commit +======================= + +.. code-block:: console + + $ git add [FILE_PATH] + $ git commit -a + +- Writing 'Related-Bug: #[Bug number in Lanuchpad]' on message content + + - We have seen in `Commit Messages <workflow-commit-message.html#9>`__ + +.. image:: ./_assets/sandbox-git-commit-message.png + :width: 80% + :align: center + +Commit log message +================== + +- (Checking log message before uploading is always a nice idea.) + +.. code-block:: console + + $ git log + +.. image:: ./_assets/sandbox-git-log.png + :width: 80% + :align: center + +Uploading to Gerrit +=================== + +.. code-block:: console + + $ git review + +.. image:: ./_assets/sandbox-git-review.png + :align: center + +Sandbox Status +============== + +- Gerrit (openstack-dev/sandbox repository) + +.. image:: ./_assets/sandbox-gerrit-submission.png + :width: 90% + :align: center + +- Launchpad (openstack-dev-sandbox) + +.. image:: ./_assets/sandbox-lp-message-added.png + :width: 80% + :align: center + +Invite peer as Reviewer +======================= + +- We have seen in `Gerrit <workflow-gerrit.html#5>`__ + +- (Find reviewer by Gerrit username or e-mail address.) + +.. image:: ./_assets/sandbox-gerrit-add-reviewer.png + :width: 80% + :align: center + +Added as Reviewer +================= + +- (Review invitation letter has been sent by e-mail.) + +.. image:: ./_assets/sandbox-gerrit-add-reviewer-added.png + :width: 80% + :align: center + +Reading review invitation +========================= + +- Review invitation letter + +.. image:: ./_assets/sandbox-review-invitation.png + :width: 80% + :align: center + +Reviewing with comment +====================== + +- Commenting + +.. image:: ./_assets/sandbox-reviewer-commenting.png + :width: 80% + :align: center + +- Draft comment was saved + +.. image:: ./_assets/sandbox-reviewer-comment.png + :width: 80% + :align: center + +Publish comment +=============== + +- (Draft comments are not visible to others.) + +.. image:: ./_assets/sandbox-reviewer-publish-comment.png + :width: 80% + :align: center + +Review Score & Results +====================== + +- Score will reflect reviewer's opinion. + +.. image:: ./_assets/sandbox-reviewer-scoring.png + :width: 80% + :align: center + +- Results will be accumulated in History. + +.. image:: ./_assets/sandbox-reviewer-comment-results.png + :width: 80% + :align: center + +Check peer's Review +=================== + +- Seeing review score with written comments + +.. image:: ./_assets/sandbox-committer-checking.png + :width: 80% + :align: center + +- Do not be frustrated! + We can revise the current patchset to address comments. + +Revising file(s) +================ + +- Start work from latest patchset + +.. image:: ./_assets/sandbox-committer-revise.png + :width: 80% + :align: center + +Amending the commit +=================== + +- We have seen in + `Setup & First Patch <workflow-setup-and-first-patch.html#8>`__ + +- (Please also change your commit message if needed.) + +.. code-block:: console + + $ git commit -a --amend + +.. image:: ./_assets/sandbox-committer-amending.png + :width: 80% + :align: center + +Uploading a new patchset +======================== + +- Executing "git review" command will submit the amended commit. + +.. image:: ./_assets/sandbox-committer-git-review-again.png + :width: 80% + :align: center + +- New patchset was recorded in Gerrit. + +.. image:: ./_assets/sandbox-gerrit-another-patchset.png + :width: 80% + :align: center + +Seeing new comment +================== + +- Since the written comment is in the previous patchset, select patchset 1, + and choose the file which has comment(s). + +.. image:: ./_assets/sandbox-gerrit-patchsets.png + :width: 50% + :align: center + +.. image:: ./_assets/sandbox-gerrit-click-file.png + :width: 80% + :align: center + +Comment reply +============= + +- Answering reviewer's comment(s) is a good manner. +- Click 'Reply' and write your message, or just 'Done' for "Done" message. + +.. image:: ./_assets/sandbox-gerrit-checking-comment.png + :width: 80% + :align: center + +.. image:: ./_assets/sandbox-gerrit-checking-comment-answer.png + :width: 80% + :align: center + +.. image:: ./_assets/sandbox-gerrit-still-draft-comment.png + :width: 80% + :align: center + +Publish comment reply +===================== + +- Draft comment publishment + +.. image:: ./_assets/sandbox-gerrit-publish-comment.png + :width: 80% + :align: center + +- (Ensure that your commment is being shown in History.) + +.. image:: ./_assets/sandbox-gerrit-comment-publish-result.png + :width: 80% + :align: center + +Review again +============ + +- Code-Review -1/0/+1 is for all OpenStack reviewers + +.. image:: ./_assets/sandbox-bug-reporter-review.png + :width: 50% + :align: center + +- Code-Review -2/+2 is for core reviewers (Sandbox repository is open) +- The Gerrit review will be merged by +1 in Workflow + +.. image:: ./_assets/sandbox-core-reviewer-score.png + :width: 50% + :align: center + +Merged! +======= + +- Score status + +.. image:: ./_assets/sandbox-scores.png + :width: 60% + :align: center + +- History status + +.. image:: ./_assets/sandbox-gerrit-merged.png + :width: 80% + :align: center + +Good manners on Sandbox +======================= + +- Please create a few logical and different changes and submit new patchsets + to those few changes in Sandbox repository for one bug in Launchpad. +- Cleaning up activities are needed + + - Includes the deletion of uploaded files on Sandbox repository + and change of bug status in Launchpad to "Invalid", "Won't Fix", + or "Fix Released" + - During upstream training, do not worry about this! Upstream training + leaders will clean up after the training is finished. + - However, please keep in mind that it is on your own responsibility. + + .. note:: + - Please do not let students create 10 or more changes. + (This is not the intention of Sandboxes!) + - http://docs.openstack.org/infra/manual/sandbox.html diff --git a/doc/upstream-training/source/website/index.rst b/doc/upstream-training/source/website/index.rst index 17a8d080..745c8c5d 100644 --- a/doc/upstream-training/source/website/index.rst +++ b/doc/upstream-training/source/website/index.rst @@ -125,6 +125,7 @@ Workflow and Tools for Participation * `Jenkins <workflow-jenkins.html>`_ * `Guide to SetUp and Push First Patch <workflow-setup-and-first-patch.html>`_ +* `Using Sandbox for Practice <workflow-using-sandbox.html>`_ Code Deep Dive --------------