From f0f434bbfcbee81b2cb6fc83fd5cc0cfe9cbfbff Mon Sep 17 00:00:00 2001 From: Victoria Bialas Date: Tue, 29 Dec 2015 11:43:09 -0800 Subject: [PATCH] updates per Ben's comments, corrected the git push statement to include create of new branch, and references to repo name now docker/kitematic Signed-off-by: Victoria Bialas --- docs/kitematic/create_pr.md | 10 ++++------ docs/kitematic/find_issue.md | 6 +++--- docs/kitematic/next_steps.md | 2 +- docs/kitematic/set_up_dev.md | 12 ++++++------ docs/kitematic/work_issue.md | 2 +- 5 files changed, 15 insertions(+), 17 deletions(-) diff --git a/docs/kitematic/create_pr.md b/docs/kitematic/create_pr.md index c152d45625..7b24039294 100644 --- a/docs/kitematic/create_pr.md +++ b/docs/kitematic/create_pr.md @@ -16,17 +16,15 @@ Rebasing helps verify that your commit is clean, and allows for an easier and fa Once you've cleaned up your commits: -1. Push your code to your repository under the same name as your local branch. +1. Push your code to your repository under the same name as your local branch (in the case of this example, 1191-branch). - $ git push origin xxxx-branch:xxxx-branch - - where _xxxx_ is the number of the issue your worked on. + $ git push origin 1191-branch:1191-branch 2. Open a web browser to your fork on GitHub. You should see the latest activity from your branch. -3. Click "Compare & pull request." +3. Click **Compare & pull request**. The system displays the pull request dialog. @@ -48,7 +46,7 @@ Once you've cleaned up your commits: ![Commits](images/pr_commits_expected.png) -6. Press "Create pull request". +6. Click **Create pull request**. The system creates the request and opens it for you in the `kitematic/kitematic` repository. diff --git a/docs/kitematic/find_issue.md b/docs/kitematic/find_issue.md index e122cc1f01..d8b14d110f 100644 --- a/docs/kitematic/find_issue.md +++ b/docs/kitematic/find_issue.md @@ -15,9 +15,9 @@ Currently, the Kitematic GUI shows the name of a selected container, but not the To find and claim an issue you want to work on: -1. Go to the `kitematic/kitematic` repository. +1. Go to the `docker/kitematic` repository. -2. Click the "Issues" link. +2. Click the **Issues** link. A list of the open issues appears. @@ -31,7 +31,7 @@ To find and claim an issue you want to work on: The comments on the issues describe the problem and can provide information for a potential solution. - For this exercise we will select the issue #xxxx Missing container id. + For this exercise we will select the issue #1191 Missing container id. 5. When you find an open issue that both interests you and is unclaimed, add a `#dibs` comment. Make sure that no other user has chosen to work on the issue. diff --git a/docs/kitematic/next_steps.md b/docs/kitematic/next_steps.md index f2e0aa22fe..a3b8165ab1 100644 --- a/docs/kitematic/next_steps.md +++ b/docs/kitematic/next_steps.md @@ -25,7 +25,7 @@ As you learned in the previous exercise, adding the container id to the containe Let's provide another missing piece of information for Kitematic users: -_When I look at an active container in Kitematic, I want to know what command the container is currently running_ +"_When I look at an active container in Kitematic, I want to know what command the container is currently running_." ![An active container in Kitematic](images/kitematic_gui_container_id.png) diff --git a/docs/kitematic/set_up_dev.md b/docs/kitematic/set_up_dev.md index 4eaa0002e2..b97734b173 100644 --- a/docs/kitematic/set_up_dev.md +++ b/docs/kitematic/set_up_dev.md @@ -65,12 +65,12 @@ the above installer link will have an uninstaller available. To fork the master branch of Kitematic: -1. Go to the kitematic/kitematic repository . +1. Go to the docker/kitematic repository . -2. Click "Fork" in the upper right corner of the GitHub interface. +2. Click **Fork** in the upper right corner of the GitHub interface. GitHub forks the repository to your GitHub account. The original - `kitematic/kitematic` repository becomes a new fork `YOUR_ACCOUNT/kitematic` + `docker/kitematic` repository becomes a new fork `YOUR_ACCOUNT/kitematic` under your account. 3. Copy your fork's clone URL from GitHub. @@ -95,9 +95,9 @@ To clone your repository and create a branch for the issue: 4. Create and checkout a branch for the issue you will be working on. - $ git checkout -b xxxx-branch + $ git checkout -b 1191-branch - where _xxxx_ is the number of the issue previously noted. + As previously mentioned, issue #1191 is set up as an example to use for this exercise. ## Set up your signature and upstream remote You can set your signature globally or locally. @@ -117,7 +117,7 @@ You can set your signature globally or locally. 4. Set your local repository to track changes upstream, on the `kitematic` repository. - $ git remote add upstream https://github.com/kitematic/kitematic.git + $ git remote add upstream https://github.com/docker/kitematic.git (To learn more, see Set up your signature and an upstream remote.) diff --git a/docs/kitematic/work_issue.md b/docs/kitematic/work_issue.md index 049cc1dc58..f79b9998a8 100644 --- a/docs/kitematic/work_issue.md +++ b/docs/kitematic/work_issue.md @@ -11,7 +11,7 @@ weight=4 ## Develop in Kitematic (work on an issue) -For this tutorial, we will work on issue #XXXX which is a request to display the container id in Kitematic for easy identification. (Currently, Kitematic shows the container name but not the id.) +For this tutorial, we will work on issue #1191 which is a request to display the container id in Kitematic for easy identification. (Currently, Kitematic shows the container name but not the id.) To do this, edit the container `General Settings` layout.