Merge pull request #1 from githubtraining/troubleshooting

First draft edits

Author: brianamarie

config.yml

@@ -12,116 +12,140 @@ before:
   - type: createIssue
     title: Welcome to this repository
     body: 00_existing-welcome.md
-#  - type: createPullRequest
-#    title: Create documentation structure
-#    body: 00_create-documentation-structure.md
-#    head: create-documentation-structure
-#  - type: mergePullRequest
-#    pullRequest: Create documentation structure
-#  - type: createPullRequest
-#    title: Add new pages
-#    body: 00_add-new-pages.md
-#    head: add-new-pages
-#  - type: mergePullRequest
-#    pullRequest: Add new pages
-#  - type: createPullRequest
-#    title: Add navigation
-#    body: 00_add-navigation.md
-#    head: add-navigation
-#  - type: mergePullRequest
-#    pullRequest: Add navigation
-#  - type: createPullRequest
-#    title: Add Git tips
-#    body: 00_add-git-tips.md
-#    head: add-git-tips
-#  - type: createStatus
-#    state: failure
-#    sha: 8a649c52d198e6ab0e80692bb660d08b299f479f
+  - type: createPullRequest
+    title: Create documentation structure
+    body: 00_create-documentation-structure.md
+    head: create-documentation-structure
+  - type: mergeBranch
+    head: create-documentation-structure
+  - type: deleteBranch
+    branch: create-documentation-structure
+  - type: createPullRequest
+    title: Add new pages
+    body: 00_add-new-pages.md
+    head: add-new-pages
+  - type: mergeBranch
+    head: add-new-pages
+  - type: deleteBranch
+    branch: add-new-pages
+  - type: createPullRequest
+    title: Add navigation
+    body: 00_add-navigation.md
+    head: add-navigation
+  - type: mergeBranch
+    head: add-navigation
+  - type: deleteBranch
+    branch: add-navigation
+  - type: createPullRequest
+    title: Add Git tips
+    body: 00_add-git-tips.md
+    head: add-git-tips
+  - type: createStatus
+    state: "failure"
+    failure:
+      description: >-
+        Please make sure that all words are spelled correctly.
+    sha: ab8fe26dfd24d863908a5074e704358023d11109
+    context: failing-build
 
 steps:
 
 # Step 1: 
   - title: Close the linked issue
     description: Close the linked issue
     event: issues.closed
-    link: '{{ repoUrl }}'
+    link: '{{ repoUrl }}/issues/1'
     actions:
       - type: createIssue
         title: Find the similar issue
         body: 01_crosslink.md
-#      - type: createIssue
-#        title: There's something similar here
-#        body: 01_the-similar-crosslink.md
-#      - type: respond
-#        with: 01_next-step.md
-#      - type: respond
-#        with: 01_next-step.md
-#        issue: Welcome to this repository
+      - type: createIssue
+        title: There's something similar here
+        body: 01_the-similar-crosslink.md
+      - type: closeIssue
+        issue: Welcome
+      - type: respond
+        with: 01_next-step.md
+      - type: respond
+        with: 01_next-step.md
+        issue: Welcome
 
 # Step 2: Crosslink
-#  - title: Create a crosslink
-#    description: Find the relevant or duplicate issue or pull request, and create a contexual crosslink
-#    event: issue_comment.created
-#    link: '{{ repoUrl }}'
-#    actions:
-#      - type: gate
-#        left: '(6)'
-#        operator: test
-#        right: '%payload.comment.body%'
-#      - type: respond
-#        with: 02_find-commit.md
+  - title: Create a crosslink
+    description: Find the relevant or duplicate issue or pull request, and create a contexual crosslink
+    event: issue_comment.created
+    link: '{{ repoUrl }}/issues/7'
+    actions:
+      - type: gate
+        left: '(8)'
+        operator: test
+        right: '%payload.comment.body%'
+      - type: respond
+        with: 02_find-commit.md
 
 # Step 3:
-#  - title: Find a commit
-#    description: Find a specific commit (related to content concept of issue in step 2)
-#    event: issue_comment.created
-#    link: '{{ repoUrl }}'
-#    actions:
-#      - type: gate
-#        left: '(312f87)'
-#        operator: test
-#        right: '%payload.comment.body%'
-#      - type: respond
-#        with: 03_context.md
+  - title: Find a commit
+    description: Find a specific commit (related to content concept of issue in step 2)
+    event: issue_comment.created
+    link: '{{ repoUrl }}/issues/7'
+    actions:
+      - type: gate
+        left: '(312f87)'
+        operator: test
+        right: '%payload.comment.body%'
+      - type: respond
+        with: 03_context.md
 
 # Step 4: Finding info and context
-#  - title: Find context
-#    description: Mention the author in the pull request where commit was created
-#    event: issue_comment.created
-#    link: '{{ repoUrl }}'
-#    actions:
-#      - type: gate
-#        left: '(proper author)'
-#        operator: test
-#        right: '%payload.comment.body%'
-#      - type: gate (validate that the comment is in the proper pull request)
-#        left: 1
-#        operator: test
-#        right: '%payload.issue.number%'
-#      - type: respond
-#        with: 04_find-broken-build.md
+  - title: Find context
+    description: Create a link to the pull request where the commit was created
+    event: issue_comment.created
+    link: '{{ repoUrl }}/issues/7'
+    actions:
+      - type: gate
+        left: '(5)'
+        operator: test
+        right: '%payload.comment.body%'
+      - type: respond
+        with: 04_find-broken-build.md
 
 # Step 5:
-#  - title: Assign yourself to the pr with broken build
-#    description: Assign yourself to the pr with broken build
-#    event: issues.assigned
-#    link: '{{ repoUrl }}'
-#    actions:
-#      - type: respond
-#        with: 05_fix-build.md
+  - title: Assign yourself to the pr with broken build
+    description: Assign yourself to the pr with broken build
+    event: pull_request.assigned
+    link: '{{ repoUrl }}/issues/7'
+    actions:
+      - type: respond
+        with: 05_fix-build.md
 
 # Step 6: Something to do with tests
-#  - title: Fix the broken build
-#    description: Fix the broken build
-#    event: push
-#    link: '{{ repoUrl }}'
-#    actions:
-#      - type: gate
-#        left: '(tricks)'
-#        operator: test
-#        right: '%payload.comment.body%'
-#      - type: createStatus
-#        state: success
-#      - type: createIssue
-#        title: Congratulations!
-#        body: 06_congratulations.md
+  - title: Fix the broken build
+    description: Fix the broken build
+    event: push
+    link: '{{ repoUrl }}/pull/6'
+    actions:
+      - type: getFileContents
+        filename: docs/git-tips.md
+        action_id: fileContents
+      - type: gate
+        left: '(tricks)'
+        operator: test
+        right: '%actions.fileContents%'
+      - type: createStatus
+        state: success
+        sha: '%payload.head_commit.id%'
+      - type: respond
+        with: 06_please-merge.md
+        issue: Add Git tips
+      
+# Step 7: Merge pull request
+  - title: Merge the pull request
+    description: Merge the final pull request
+    event: push
+    link: '{{ repoUrl }}/pull/6'
+    actions:
+      - type: createIssue
+        title: Congratulations!
+        body: 07_congratulations.md
+      - type: respond
+        with: 07_final-issue.md

responses/00_add-git-tips.md

@@ -1,3 +1,5 @@
 # Adding Git Tips
 
-This pull request adds tips and tricks for using Git.
+This pull request adds a page to the documentation about tips and tricks for using Git.
+
+_Note: This is the pull request that you should assign yourself to in step 5._

responses/00_add-navigation.md

@@ -1,3 +1,3 @@
 # Add navigation
 
-This pull request introduces navigation to the documentation
+This pull request introduces navigation to the documentation.

responses/00_add-new-pages.md

@@ -1,3 +1,3 @@
-# adding new pages
+# Adding new pages
 
-pull request for adding new pages
+This pull request introduces new pages to the documentation.

responses/00_create-documentation-structure.md

@@ -1 +1,3 @@
-This is a pull request for introducing the documentation strucutre for docsify.
+# Documentation structure
+
+This pull request introduces the structure for the documentation.

responses/00_existing-welcome.md

@@ -1,3 +1,3 @@
 # Welcome!
 
-(This is the issue that has duplicate information as the other welcome issue, and we will ask users to close this issue.) It's important that this issue references the other welcome issue, like #1
+Welcome to the course! We're going to walk through some strategies for dealing with large repositories. This is a similar issue to #1, but I'll let you decide if we should keep it or not.

responses/00_welcome-issue.md

@@ -1,7 +1,25 @@
-# Welcome to this course!
+# Welcome!
 
-## Step 1: Find and close the crosslinked issue
+Welcome to this Learning Lab course about working in large repositories. For example, you could be working in repositories with a lot of history. Or, working with many collaborators. No matter how your repository is "large", it's important to know how to navigate your workspace.
 
-### :keyboard: Activity: 
+In this course, you'll learn how to do lots of things, like:
 
-Find the issue that is crosslinked automatically from the instruction issue and close it because we don't need multiple threads with the same things. Maybe there's some info to bring over? Describing course goals really high level, and describing crosslinks between issues and pull requests
+- Find relevant issues and pull requests
+- Search history to find context
+- Make connections within GitHub to help others find things
+
+### Cross-linking issues and pull requests
+
+GitHub has special capabilities to help reference other information on GitHub. For example, if someone references a GitHub issue or pull request from another issue or pull request, a link is created. At the same time, a cross-reference is created in the other issue. This two-way reference helps people track relationships of information across GitHub.
+
+## Step 1: Find an issue
+
+Below, you will see a reference to another issue. The other issue references _this_ issue. The other issue appears to be a duplicate, so it would be a good idea to close it.
+
+### :keyboard: Activity: Find and close the cross-linked issue
+
+1. Find the other issue referenced from this issue
+2. Close that issue
+
+<hr>
+<h3 align="center">I will respond with your next steps in that issue.</h3>

responses/01_crosslink.md

@@ -1,9 +1,23 @@
 # Finding relevant history
 
-This is a new issue that has content similar to another issue. (or they could be pull requests). (In an existing issue that has a related issue or pull request buried somewhere) 
+When you're working in a repository, you might want to find other issues or pull requests. Maybe someone has told you about a conversation, but they didn't send you a direct link. Or, maybe you remember an issue from the past but you don't know exactly where it is.
 
-## Step 2: 
+Next, we'll practice finding issues and creating crosslinks to improve discoverability later.
 
-## :keyboard: Activity: 
+### Finding issues and pull requests
+
+You can search for issues and pull requests in many ways, like by author, title, or even the most recently updated. You can also search closed issues. You can read all about the different ways to search in the [GitHub Help documentation](https://help.github.com/en/articles/searching-issues-and-pull-requests#search-by-open-or-closed-state).
+
+### Creating references
+
+When you link to another issue, a reference within GitHub is automatically created. In fact, you don't even need to include the full link. If you were to type `#5` within a comment, that would turn into a link to issue or pull request number 5.
+
+When you want to create a crosslink, try typing the title of an issue or pull request directly after you type the `#` symbol. GitHub will suggest issues or pull requests that will link to the right place. To learn even more, check out [GitHub's documentation](https://help.github.com/en/articles/autolinked-references-and-urls).
+
+## Step 2: Create crosslinks
+
+## :keyboard: Activity: Find and link to a related issue
+
+1. Please find the related issue
+2. Comment in this issue with a reference to the related issue with a short description
 
-Please find the related issue and create a crosslink with a short description. Info about how to find issues and pull requests.

responses/01_next-step.md

@@ -1 +1 @@
-Your next steps can be found: 
+[Your next steps can be found here]({{ repoUrl }}/issues/7).

responses/01_the-similar-crosslink.md

@@ -1,3 +1,11 @@
-# The similar one
+# How to find issues and pull requests
 
-This is a similar issue to 01_crosslink.md and should be crosslinked.
+When you're working in a repository, you might want to find other issues or pull requests. Maybe someone has told you about a conversation, but they didn't send you a direct link. Or, maybe you remember an issue from the past but you don't know exactly where it is.
+
+### Finding conversations
+
+You can read all about the different ways to search in the [GitHub Help documentation](https://help.github.com/en/articles/searching-issues-and-pull-requests#search-by-open-or-closed-state).
+
+### Creating Links
+
+To learn about creating references, check out [GitHub's documentation](https://help.github.com/en/articles/autolinked-references-and-urls).