Merge branch 'master' into github-103-review

mateusortiz · Sep 1, 2017 · 3056e6c · 3056e6c
2 parents ccef2e4 + ff2c37a
commit 3056e6c
Show file tree

Hide file tree

Showing 42 changed files with 159 additions and 106 deletions.
diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md
@@ -11,10 +11,10 @@
 <If new idea or direction, please create a checklist of proposed ideas or next steps. [Example](https://github.com/github/training-kit/issues/415).>
 
 ### How to Contribute
-- [ ] Comment on this issue if you'd like to work/collaborate on it! 
+- [ ] Comment on this issue if you'd like to work/collaborate on it!
 - [ ] Fork the [repository](https://github.com/github/training-kit).
-- [ ] Use the [GitHub Flow](https://guides.github.com/introduction/flow/) to make changes to your fork. [This](https://services.github.com{{site.baseurl}}/intro-to-github/) is a refresher course if you're unsure about how to make a change on GitHub.
-- [ ] Push your changes to your repository. 
+- [ ] Use the [GitHub Flow](https://guides.github.com/introduction/flow/) to make changes to your fork. [This](https://services.github.com/on-demand/intro-to-github/) is a refresher course if you're unsure about how to make a change on GitHub.
+- [ ] Push your changes to your repository.
 - [ ] Submit a Pull Request
   - Base Dropdown: github/training-kit
   - Compare Dropdown: Your fork
@@ -26,7 +26,7 @@ If you'd like to make and test changes locally (and see how they would look if m
   - [Install Ruby](https://www.ruby-lang.org/en/documentation/installation/)
   - [ ] Run `script/setup`
   - [ ] Run `script/server`.
-    - When successful, the script will initiate a local server at `http://127.0.0.1:4000{{site.baseurl}}`.
+    - When successful, the script will initiate a local server at `http://127.0.0.1:4000/on-demand`.
 
 ### Questions?
 - Leave a comment on this issue! Make sure to use @ mentions if you want a specific person's attention!
diff --git a/README.md b/README.md
@@ -5,13 +5,13 @@
 # GitHub Training Kit
 ### Home of GitHub's On-Demand training
 
-This repository contains the completely open source on-demand training hosted at https://services.github.com{{site.baseurl}}/. These materials are provided under a [_Creative Commons License_ license](https://github.com/github/training-kit/blob/master/LICENSE).
+This repository contains the completely open source on-demand training hosted at https://services.github.com/on-demand/. These materials are provided under a [_Creative Commons License_ license](https://github.com/github/training-kit/blob/master/LICENSE).
 
 ## We :heart: Contributors Like You!
 
 **We’re eager to work with you**, our user community to improve these materials and develop new ones. Here's how you can help:
 
-- **You spotted a mistake:** please feel free to fork the repository and submit a change via Pull Request (not sure how to do that, [we have a course for you](https://services.github.com{{site.baseurl}})).
+- **You spotted a mistake:** please feel free to fork the repository and submit a change via Pull Request (not sure how to do that, [we have a course for you](https://services.github.com/on-demand/)).
 - **You have an idea to make it better:** we :heart: new ideas! We invite you to open a new [Issue](https://github.com/github/training-kit/issues) if you want to talk about it, or you can [fork this repository](https://help.github.com/articles/working-with-forks/) and submit your idea via a Pull Request.
 - **You just want to help:** check out the [open issues](https://github.com/github/training-kit/issues) for projects you can tackle, review an [open pull request](https://github.com/github/training-kit/pulls), or check out [the project ROADMAP](https://github.com/github/training-kit/projects/1).
 
@@ -21,8 +21,8 @@ For more information on contributing to this repository, check out our [CONTRIBU
 
 This repository contains three primary resources:
 
-- Our current [on-demand courses](https://services.github.com{{site.baseurl}}/) can be found in the [paths directory](/paths)
-- The translations of our popular [Git Cheat Sheets](https://services.github.com{{site.baseurl}}/downloads/github-git-cheat-sheet.pdf) can be found in the [downloads directory](/downloads). We're always looking for more. _P.S._ Right now the PDF generation is a manual process so please mention @github/services-training for assistance in getting your translation moved to the PDF.
+- Our current [on-demand courses](https://services.github.com/on-demand/) can be found in the [paths directory](/paths)
+- The translations of our popular [Git Cheat Sheets](https://services.github.com/on-demand/downloads/github-git-cheat-sheet.pdf) can be found in the [downloads directory](/downloads). We're always looking for more. _P.S._ Right now the PDF generation is a manual process so please mention @github/services-training for assistance in getting your translation moved to the PDF.
 - The recommended Training Path can be found [here](https://services.github.com/resources/learning-path/).
 
 ## Our Content Philosophy
@@ -47,7 +47,7 @@ To perform a build of the materials perform the following:
 
 1. Run `script/setup`
 1. Run `script/server`.
-    - When successful, the script will initiate a local server at `http://127.0.0.1:4000{{site.baseurl}}`.
+    - When successful, the script will initiate a local server at `http://127.0.0.1:4000/on-demand/`.
 1. Simply paste that into your favorite web-browser and you will be ready to test.
 1. You'll also need to run the following script to compile the SCSS (you can remove the `watch` flag if desired):
 ```
@@ -69,7 +69,7 @@ If you'd like to have a copy of the files to be served from a web server inside
 Site content is licensed under [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/). CC-BY-4.0 gives you permission to use content for almost any purpose but does not grant you any trademark permissions, so long as you note the license and give credit, such as follows:
 
 > Content based on
-> <a href="https://services.github.com{{site.baseurl}}/">services.github.com{{site.baseurl}}</a>
+> <a href="https://services.github.com/on-demand/">services.github.com/on-demand/</a>
 > used under the
 > <a href="https://creativecommons.org/licenses/by/4.0/">CC-BY-4.0</a>
 > license.</a>

diff --git a/_includes/activity/gh-pages/02-create-profile.md b/_includes/activity/gh-pages/02-create-profile.md
@@ -30,5 +30,5 @@ Don't worry if you don't want to put your actual information up online. It's OK
   {{ activity-text | markdownify }}
 </div>
 
-Need help? **Open an issue** [in our class repository](https://github.com/githubschool{{site.baseurl}}-github-pages/issues/new) for answers from GitHub trainers!
+Need help? **Open an issue** [in our class repository](https://github.com/githubschool/on-demand-github-pages/issues/new) for answers from GitHub trainers!
 {: .notice--success}
diff --git a/_includes/activity/gh-pages/03-create-new-page.md b/_includes/activity/gh-pages/03-create-new-page.md
@@ -15,5 +15,5 @@ Time to add our work history as a page to our Jekyll site.
   {{ activity-text | markdownify }}
 </div>
 
-Need help? **Open an issue** [in our class repository](https://github.com/githubschool{{site.baseurl}}-github-pages/issues/new) for answers from GitHub trainers!
+Need help? **Open an issue** [in our class repository](https://github.com/githubschool/on-demand-github-pages/issues/new) for answers from GitHub trainers!
 {: .notice--success}
diff --git a/_includes/activity/gh-pages/04-more-content.md b/_includes/activity/gh-pages/04-more-content.md
@@ -24,5 +24,5 @@ You might also look into the "collections" functionality in Jekyll. This would l
   {{ activity-text | markdownify }}
 </div>
 
-Need help? **Open an issue** [in our class repository](https://github.com/githubschool{{site.baseurl}}-github-pages/issues/new) for answers from GitHub trainers!
+Need help? **Open an issue** [in our class repository](https://github.com/githubschool/on-demand-github-pages/issues/new) for answers from GitHub trainers!
 {: .notice--success}
diff --git a/_includes/activity/github-desktop/12-add-class-repo.md b/_includes/activity/github-desktop/12-add-class-repo.md
@@ -1,9 +1,5 @@
 [//]: # "This is used in both the CLI and Desktop course"
 
-It's time to share your page with the world! To do that, you will follow the same steps of the GitHub workflow, but this time you will do it on the class repository.
-
-![gif of following the directions below](../images/gifs/github-desktop/join-repo-make-issue-pages.gif)
-
 1. Visit the [class repository](https://github.com/githubschool/on-demand-github-pages/).
 1. Click the **Issues** tab.
 1. Request push access by [creating an Issue](https://github.com/githubschool/on-demand-github-pages/issues/).
diff --git a/_includes/activity/intro-to-github/00-create-github-account.md b/_includes/activity/intro-to-github/00-create-github-account.md
@@ -2,9 +2,11 @@ For this class, you will need an account on GitHub.com.
 
 If you already have a Github.com account you are ready to get started. Otherwise, you can set up your free account by following these steps:
 
-1. Access GitHub.com and click Sign up.
-2. Choose the free account.
-3. You will receive a verification email at the address provided.
-4. Click the emailed link to complete the verification process.
+![gif of the following directions](../images/gifs/intro/sign-in.gif)
+
+1. Access [GitHub.com](https://github.com) and click and enter a username, email address, and password in the supplied field and click **Sign up for GitHub**.
+1. Select the **Unlimited public repositories for free** option.
+1. You will receive a verification email at the address provided.
+1. Click the emailed link to complete the verification process.
 
 If you are wondering where to go from here, click **Tell me why** for a quick tour of your dashboard.
diff --git a/_includes/activity/intro-to-github/01-join-intro-repo.md b/_includes/activity/intro-to-github/01-join-intro-repo.md
@@ -1,4 +1,7 @@
 It's time to get your hands dirty! Use these steps to access our shared project:
 
+![gif of the directions]( ../images/gifs/intro/join-repo-make-issue-introduction.gif)
+
 1. Sign in with your GitHub account.
-2. Navigate to our shared project and become a collaborator. Click on [this link](https://github.com/githubschool/open-enrollment-classes-introduction-to-github/issues/) and create an issue. The GitHubTeacher user will auto-magically add you to our project as a collaborator.
+1. Navigate to our [shared project](https://github.com/githubschool/open-enrollment-classes-introduction-to-github/issues/) and click the **New issue** button.
+1. Enter a title for your issue and click **Submit new issue**. The GitHubTeacher user will auto-magically add you to our project as a collaborator.
diff --git a/_includes/activity/intro-to-github/03-create-branch.md b/_includes/activity/intro-to-github/03-create-branch.md
@@ -1,6 +1,10 @@
 It is time to create the branch you will use to add your pin to the map. Here's how you do it:
 
+![gif of directions](../images/gifs/intro/create-branch-intro.gif)
+
 1. Navigate to the <a href="https://github.com/githubschool/open-enrollment-classes-introduction-to-github/" target="_blank">Code tab</a> in the class repository.
-2. Click the drop-down titled `master`.
-3. In the field, enter this unique name for your branch: `<your-username-your-city>`.
-4. Press Enter to create your branch.
+2. Click the drop-down titled **Branch: master**.
+3. In the field, enter this unique name for your branch: `your-username-your-city`.
+4. Click **Create branch: your-username-your-city** or press the Enter key to create your branch.
+
+> When you begin typing in the branch field, a blue button should display, if it doesn't, you aren't a collaborator on the project and need to create an issue [here](https://github.com/githubschool/open-enrollment-classes-introduction-to-github/issues/).
diff --git a/_includes/activity/intro-to-github/04-create-a-file-on-github.md b/_includes/activity/intro-to-github/04-create-a-file-on-github.md
@@ -1,5 +1,7 @@
 It's time to add your file to the repository:
 
+![gif of directions](../images/gifs/intro/working-on-github.gif)
+
 1. In your new branch, add a new file named: `_pins/YOUR-USERNAME.json`.
 1. Enter the following content into your file:
 

diff --git a/_includes/activity/intro-to-github/05-create-a-pull-request.md b/_includes/activity/intro-to-github/05-create-a-pull-request.md
@@ -1,10 +1,12 @@
 Now that you have created a file, you will create a Pull Request to show your proposed changes to others who are completing this project:
 
+![gif of directions](../images/gifs/intro/pull-request-intro.gif)
+
 1. Navigate to the <a href="https://github.com/githubschool/open-enrollment-classes-introduction-to-github/pulls" target="_blank">Pull Requests tab</a>.
 2. Click `New Pull Request`.
-3. In the *base* dropdown, choose `master`.
-4. In the *compare* dropdown, choose your branch.
-5. Click `Create Pull Request`
+3. In the **base** dropdown, choose `master`.
+4. In the **compare** dropdown, choose your branch.
+5. Click **Create pull request**.
 6. You can leave the default title or make it more descriptive.
 7. Use [markdown formatting](https://guides.github.com/features/mastering-markdown/) to explain the work you have done on your branch.
   - Summarize your proposed change.
@@ -13,6 +15,6 @@ Now that you have created a file, you will create a Pull Request to show your pr
 
    > Pull Request messages are an excellent opportunity for you to describe the changes you have made to the project. For example, you could also include information explaining the type of feedback you'd like others to give you or providing collaborators an idea of your timeline.
 
-8. Click *Preview* to see how your Pull Request will look.
-9. Assign the pull request to yourself by clicking `assign to yourself` in the Assignees section.
-10. Click `Create Pull Request`.
+8. Click **Preview** to see how your Pull Request will look.
+9. Assign the pull request to yourself by clicking **assign to yourself** in the Assignees section.
+10. Click `Create pull request`.
diff --git a/_includes/activity/intro-to-github/05a-collaborate-on-pull-request.md b/_includes/activity/intro-to-github/05a-collaborate-on-pull-request.md
@@ -1,4 +1,6 @@
 :tada: Congratulations! You have created your Pull Request. Now it is time to put your collaborator hat on and go help others!
 
+![gif of directions](../images/gifs/intro/collaborate.gif)
+
 1. Now that your pull request has been created, go back to the pull request list to find an <a href="https://github.com/githubschool/open-enrollment-classes-introduction-to-github/pulls?q=is%3Aopen+is%3Apr" target="_blank">open pull request</a> -- other than your own.
 1. Provide feedback :loudspeaker: and motivation :tada:.
diff --git a/_includes/activity/intro-to-github/06-merge-a-pr.md b/_includes/activity/intro-to-github/06-merge-a-pr.md
@@ -1,7 +1,9 @@
 If all of your checks are passing and you do not have any requested changes from other students, you can go ahead and merge your pull request:
 
+![gif of directions](../images/gifs/intro/merge-intro.gif)
+
 1. Open your [Pull Request](https://github.com/githubschool/open-enrollment-classes-introduction-to-github/pulls) to be merged.
 1. Scroll to the bottom of the Pull Request and click the **Merge pull request** button.
 1. You can accept the default merge commit message.
 1. Click **Confirm merge**.
-1. Delete the branch, as it no longer contains unique work.
+1. Click **Delete branch** to delete the branch, as it no longer contains unique work.
diff --git a/_includes/help-build-fail.md b/_includes/help-build-fail.md
@@ -20,15 +20,3 @@ The build can fail because of many reasons. By looking at the details of the **T
 The build log of Travis CI may appear a little cryptic. But with some careful reading you might be able to pull out the reason why your build is failing. (By the way, if you think the `job log` is cryptic, try and click on the `Raw log`.)
 
 The build script is a series of commands. It might be helpful to know that **every new command starts with a `$` sign**. Such commands can be something simple or a new (sub)script. The individual properties of your _branch_ are tested in individual scripts. For example, **Travis CI** very early on tests whether your file is formatted as an appropriate "`.yaml` file".
-
-#### 404 error
-Somewhere down the cascade of tests **Travis CI** will check if the URL following `pageUrl` actually exists. The test and the complete build will fail if a website does not exist (a "404 error").
-
-It is possible you might have mistyped your URL or something went wrong when you tried to publish your website. It is also possible that users who previously merged their branch with the master have sadly deleted their repository and their website disappeared.
-
-Try and discover in the log which URL is causing a 404 error. You can double check whether the website exist by copying it into your browser.
-
-Because you are working in your own branch it is safe to change the code however you like. If you see something that can be fixed easily you could just edit the offending file. For instance you can replace the broken URL with something that does exist (e.g. `github.com`).
-A more rigorous solution would be to delete the file altogether.
-
-Once your fix is correct and the build is no longer failing, you are ready to merge your branch with the `master`. You might get some merge conflicts you will need to address first. Ask `@githubteacher` if you get stuck.
diff --git a/_includes/help-gh101-common.md b/_includes/help-gh101-common.md
@@ -0,0 +1,28 @@
+### Troubleshooting Common Issues
+
+These are a couple of the reasons that builds can fail in this class. If your pull request is not passing and can't be merged, double check the following things:
+
+#### File Name is Incorrect
+
+The file for the class should be in the `/_pins` folder and should be named `YOUR-USERNAME`.json. Double check to make sure that:
+
+ - Your file isn't in the: `/_pin` or `/pins` folders.
+ - Your file doesn't end with: `.jason`, `.md`, `.txt`.
+
+#### Format of the File is Incorrect
+
+The contents of your `.json` file should look like this:
+
+  ```
+  ---
+  githubHandle: YOUR-USERNAME
+  latitude:
+  longitude:
+  ---
+
+  ```
+Double check that:
+
+- You included 3 dashes before and after your code `---` and not `...` or other characters.
+- The `H` in `Handle` is capitalized
+- The spelling of `Handle`, `latitude`, and `longitude`.
diff --git a/_includes/help-gh102-103-404.md b/_includes/help-gh102-103-404.md
@@ -0,0 +1,11 @@
+#### 404 error
+Somewhere down the cascade of tests **Travis CI** will check if the URL following `pageUrl` actually exists. The test and the complete build will fail if a website does not exist (a "404 error").
+
+It is possible you might have mistyped your URL or something went wrong when you tried to publish your website. It is also possible that users who previously merged their branch with the master have sadly deleted their repository and their website disappeared.
+
+Try and discover in the log which URL is causing a 404 error. You can double check whether the website exist by copying it into your browser.
+
+Because you are working in your own branch it is safe to change the code however you like. If you see something that can be fixed easily you could just edit the offending file. For instance you can replace the broken URL with something that does exist (e.g. `github.com`).
+A more rigorous solution would be to delete the file altogether.
+
+Once your fix is correct and the build is no longer failing, you are ready to merge your branch with the `master`. You might get some merge conflicts you will need to address first. Ask `@githubteacher` if you get stuck.
diff --git a/_includes/scripts.html b/_includes/scripts.html
@@ -29,9 +29,8 @@
 <script type="text/javascript">
 $(document).ready(function(){
 
-
     $('#github_chart_1').github_graph( {
-      data: 'https://githubschool.github.io{{site.baseurl}}-github-pages/createDirectory.json' ,
+      data: 'https://githubschool.github.io/on-demand-github-pages/createDirectory.json' ,
       texts: ['site added to our directory','sites added to our directory'],
       link: 'this is the link'
     });

diff --git a/_includes/tell-me-why/branching.md b/_includes/tell-me-why/branching.md
@@ -2,7 +2,7 @@
 
 ## Reviewing the GitHub Flow
 
-Remember, we used the GitHub Flow in [Introduction to GitHub](https://github.github.com{{site.baseurl}}/intro-to-github/), and we use it again here! :smile:
+Remember, we used the GitHub Flow in [Introduction to GitHub]({{ site.baseurl }}/intro-to-github/), and we use it again here! :smile:
 
 The main steps of the GitHub workflow are: