Skip to content
This repository has been archived by the owner on Sep 1, 2022. It is now read-only.

Commit

Permalink
Audit march 2019 (#13)
Browse files Browse the repository at this point in the history
* audit march 2019 - update responses

* rename files for consistency

* update URL references to be accurate

* github pages site point to owner, not user

* add course preference with dotcom as default

* include branch name when merging and deleting branch in cli preference

* add note about using git status generously in cli preference
  • Loading branch information
brianamarie authored Mar 14, 2019
1 parent 8c65222 commit dcd4433
Show file tree
Hide file tree
Showing 37 changed files with 543 additions and 244 deletions.
80 changes: 54 additions & 26 deletions config.yml
Original file line number Diff line number Diff line change
@@ -1,9 +1,19 @@
title: "Communicating using Markdown"
title: "Communicating using Markdown Test"
tagline: "Your guide to mastering Markdown"
description: "This course will walk you through everything you need to start organizing ideas and collaborating using Markdown, a lightweight language for text formatting."
template:
name: "markdown-portfolio"
repo: "communicating-using-md-template"
preferences:
- type: radio
name: gitTool
label: Preferred Git tool
description: You can follow this course's instructions using whichever Git tool you prefer.
options:
- label: GitHub.com
value: dotcom
- label: Command line
value: cli
tags: [
"GitHub","Markdown"
]
Expand All @@ -15,10 +25,11 @@ before:
include_admins: true
- type: createIssue
title: Getting Started with GitHub
body: "01-welcome.md"
body: "00_welcome.md"
comments:
- "01a-create-tasklist.md"
- "00_create-tasklist.md"
steps:
#1 - Create a task list
- title: "Create a task list"
description: "Learn about task lists in your first issue."
event: "issue_comment.created"
Expand All @@ -35,12 +46,15 @@ steps:
right: '%payload.comment.body%'
else:
- type: respond
with: '01d-tasklist.md'
with: '01_tasklist.md'
- type: respond
with: '01e-taskwhitespaces.md'
with: '01_taskwhitespaces.md'
- type: respond
with: '01b-turn-on-ghp.md'
with: '01_turn-on-ghp.md'
data:
url: '%payload.repository.html_url%'

#2 - Turn on GitHub Pages
- title: "Turn on GitHub Pages"
description: "Create serve your repository contents on a web page using GitHub Pages."
event: "deployment"
Expand All @@ -49,16 +63,20 @@ steps:
- type: createPullRequest
action_id: pr
title: Give your portfolio a header
body: '02-headers.md'
body: '02_headers.md'
head: add-headers
data:
thePayload: '%payload%'
- type: closeIssue
issue: Getting Started with GitHub
- type: respond
issue: Getting Started with GitHub
with: '01c-close-issue.md'
with: '02_close-issue.md'
data:
url: 'https://%payload.repository.owner.login%.github.io/%payload.repository.name%'
prUrl: '%actions.pr.data.html_url%'

#3 - Add headers
- title: "Add headers"
description: "Add headers to some unformatted content."
event: "pull_request.synchronize"
Expand All @@ -73,11 +91,12 @@ steps:
right: '%actions.fileContents%'
else:
type: respond
with: 03-request-changes.md
with: 03_request-changes.md
- type: removeBranchProtection
- type: respond
with: 03-pr-succeeds.md
with: 03_pr-succeeds.md

#4 - Merge your headers
- title: "Merge your headers"
description: "Merge your first PR to see headers in action."
event: "pull_request.closed"
Expand All @@ -89,13 +108,15 @@ steps:
- type: createPullRequest
action_id: pr
title: Introduce yourself to the world
body: 04-add-image.md
body: 04_add-image.md
head: add-images-links
- type: respond
with: 03-next.md
with: 04_next.md
data:
url: 'https://%payload.repository.owner.login%.github.io/%payload.repository.name%'
prUrl: '%actions.pr.data.html_url%'

#5 - Add an image
- title: "Add an image"
description: "Learn how to place images in Markdown by adding your photo."
event: "pull_request.synchronize"
Expand All @@ -110,10 +131,11 @@ steps:
right: '%actions.fileContents%'
else:
type: respond
with: 04-request-changes-image.md
with: 05_request-changes-image.md
- type: respond
with: 04-image-works-url.md

with: 05_image-works-url.md

#6 - Add a profile link
- title: "Add a profile link"
description: "Learn how to create links in Markdown."
event: "pull_request.synchronize"
Expand All @@ -128,11 +150,12 @@ steps:
right: '%actions.fileContents%'
else:
type: respond
with: 04-request-changes-link.md
with: 06_request-changes-link.md
- type: removeBranchProtection
- type: respond
with: 04-success.md
with: 06_success.md

#7 - Merge your image and link
- title: "Merge your image and link"
description: "Merge your second PR to introduce yourself to the world."
event: "pull_request.closed"
Expand All @@ -143,14 +166,16 @@ steps:
- type: updateBranchProtection
- type: createPullRequest
title: A few of your favorite things
body: 05-pr-body.md
body: 07_pr-body.md
action_id: pr
head: add-lists-emphasis
- type: respond
with: 04-next.md
with: 07_next.md
data:
url: 'https://%payload.repository.owner.login%.github.io/%payload.repository.name%'
prUrl: '%actions.pr.data.html_url%'

#8 - Add a list
- title: "Add a list"
description: "Learn to how to create ordered and unordered lists."
event: "pull_request.synchronize"
Expand All @@ -165,10 +190,11 @@ steps:
right: '%actions.fileContents%'
else:
type: respond
with: 05-request-changes.md
with: 08_request-changes.md
- type: respond
with: 06-emphasis.md
with: 08_emphasis.md

#9 - Use emphasis
- title: "Use emphasis"
description: "Use bold and italics to emphasize text."
event: "pull_request.synchronize"
Expand All @@ -183,11 +209,12 @@ steps:
right: '%actions.fileContents%'
else:
type: respond
with: 06-request-changes.md
with: 09_request-changes.md
- type: removeBranchProtection
- type: respond
with: 05-success.md
with: 09_success.md

#10 - Merge lists and emphasis
- title: "Merge lists and emphasis"
description: "Merge the last updates to your portfolio."
event: "pull_request.closed"
Expand All @@ -197,17 +224,18 @@ steps:
left: '%payload.pull_request.merged%'
- type: createIssue
title: More to learn
body: 07-more-to-learn.md
body: 10_more-to-learn.md
action_id: issue
- type: mergeBranch
head: add-theme
- type: respond
with: 06-next.md
with: 10_next.md
data:
url: 'https://%payload.repository.owner.login%.github.io/%payload.repository.name%'
issueUrl: '%actions.issue.data.html_url%'
- type: octokit
method: repos.edit
owner: '%payload.repository.owner.login%'
repo: '%payload.repository.name%'
name: '%payload.repository.name%'
homepage: 'https://%user.username%.github.io/%payload.repository.name%'
homepage: 'https://%payload.repository.owner.login%.github.io/%payload.repository.name%'
Original file line number Diff line number Diff line change
@@ -1,15 +1,16 @@
## Step 1: Create a Task List

A task list creates checkboxes that can be checked off by people with access <sup>[:book:](https://help.github.com/articles/github-glossary/#collaborator)</sup> in a repository. They're very useful for tracking issues and pull requests.
A task list creates checkboxes for people with access <sup>[:book:](https://help.github.com/articles/github-glossary/#collaborator)</sup>in a repository to check off. They're very useful for tracking issues and pull requests.

If you include a task list in the first comment of an issue or pull request, you'll see a progress indicator in your issue list.
If you include a task list in the body of an issue or pull request, you'll see a progress indicator in your issue list.

Watch out! The syntax for task lists is very specific. Be sure to include the spaces where required, or else they won't render.

Watch out! The syntax for task lists is very specific. Be sure to include the spaces where required, or else they won't render properly.

#### Example markup

```
- [x] Additional markup is supported, including @mentions, #referencess, [links](url), **emphasis**, and <del>HTML tags</del>.
- [x] Additional markup is supported, including @mentions, #references, [links](url), **emphasis**, and <del>HTML tags</del>.
- [x] List syntax is required.
- You can nest lists below, too!
- [x] This item is completed.
Expand All @@ -18,10 +19,10 @@ Watch out! The syntax for task lists is very specific. Be sure to include the sp

#### Rendered

- [x] Additional markup is supported, including @mentions, #referencess, [links](url), **emphasis**, and <del>HTML tags</del>.
- [x] Additional markup is supported, including @mentions, #references, [links](url), **emphasis**, and <del>HTML tags</del>.
- [x] List syntax is required.
- You can nest lists below, too!
- [x] This item is completed.
- [x] This item is complete.
- [ ] This item is not complete.

### :keyboard: Activity: Add a comment
Expand All @@ -32,12 +33,12 @@ Watch out! The syntax for task lists is very specific. Be sure to include the sp
- [ ] Outline my portfolio
- [ ] Introduce myself to the world

1. Use the **Preview** tab to check your markdown formatting
1. Click **Comment**
1. Use the **Preview** tab to check your markdown formatting.
1. Click **Comment**.

For a printable version of the steps in this course, check out the [Quick Reference Guide]({{ host }}/public/{{ course.slug }}.pdf).

<hr>
<h3 align="center">Watch below your comment for my response</h3>
<h3 align="center">Watch below your comment for my response.</h3>

> _If you perform an expected action and don't see a response from me after a few seconds, refresh the page for your next steps._
3 changes: 1 addition & 2 deletions responses/01-welcome.md → responses/00_welcome.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,7 @@ In this repository <sup>[:book:](https://help.github.com/articles/github-glossar

### What is Markdown?

Markdown is a lightweight syntax for writing all types of communication on GitHub, as well as many other places on the web. You can format words as **bold** or _italic_, add images, and create lists. Mostly, Markdown is just regular text combined with a few non-alphabetic symbols, such as `#` or `*`. You can use Markdown with the formatting toolbar in issues <sup>[:book:](https://help.github.com/articles/github-glossary/#issues)</sup> and pull requests <sup>[:book:](https://help.github.com/articles/github-glossary/#pull-request)</sup>, or you can learn the syntax and type it yourself.

Markdown is a lightweight syntax for communicating on GitHub, and many other websites. You can format words as **bold** or _italic_, add images, and create lists. Markdown is regular text combined with a few non-alphabetic symbols, such as `#` or `*`. You can use Markdown with the formatting toolbar in issues <sup>[:book:](https://help.github.com/articles/github-glossary/#issues)</sup> and pull requests <sup>[:book:](https://help.github.com/articles/github-glossary/#pull-request)</sup>, or you can type the syntax.

You can use Markdown most places around GitHub:

Expand Down
2 changes: 1 addition & 1 deletion responses/01d-tasklist.md → responses/01_tasklist.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ I didn't see a task list in that comment. Remember, a task list starts with the
- [ ] Introduce myself to the world
```

If you would like assistance troubleshooting the issue you are encountering, create a post on the [GitHub Community]({{ communityBoard }}) board. You might also want to search for your issue to see if other people have resolved it in the past.
If you would like assistance troubleshooting, create a post on the [GitHub Community]({{ communityBoard }}) board. You might also want to search for your issue to see if other people have resolved it in the past.

<hr>
<h3 align="center">Watch below your comment for my response</h3>
File renamed without changes.
9 changes: 4 additions & 5 deletions responses/01b-turn-on-ghp.md → responses/01_turn-on-ghp.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,16 @@
## Step 2: Turn on GitHub Pages

Nicely done @{{ user.username }}! At least one task in your Markdown to-do list is correct. :sparkles:
Nicely done @{{ user.username }}!

Now let's turn our focus to the content of your portfolio. Because this portfolio will be displayed as a static web page, you'll need to enable GitHub Pages.
Now let's turn our focus to the content of your portfolio. Because this portfolio will display as a static web page, you'll need to enable GitHub Pages.

### :keyboard: Activity: Enable GitHub Pages
1. Under your repository name, click [**Settings**](https://github.com/{{ user.username }}/{{ repo }}/settings).
1. Under your repository name, click [**Settings**]({{ url }}/settings).
1. In the **GitHub Pages** section, use the **Select source** drop-down menu to select `master` as your GitHub Pages publishing source.
1. Click **Save**.

> _I may take up to a minute to respond as I wait for GitHub Pages to create a deployment of your repository_.
> _For more information, see [Configuring a publishing source for GitHub Pages](https://help.github.com/articles/configuring-a-publishing-source-for-github-pages/) in the GitHub Help._
<hr>
<h3 align="center">Return to this issue for next steps</h3>
<h3 align="center">Return to this issue for next steps.</h3>
15 changes: 0 additions & 15 deletions responses/02-resume.md

This file was deleted.

Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Take a look at your published site here: https://{{ user.username }}.github.io/{{ repo }}
Take a look at your published site here: {{ url }}

As we add content throughout the course, this site will update.

Expand Down
32 changes: 31 additions & 1 deletion responses/02-headers.md → responses/02_headers.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,12 +24,42 @@ The toolbar isn't available everywhere. When you edit a file, you must type the

### :keyboard: Activity: Edit your file with headers

{% if preferences.gitTool == 'cli' %}
1. Open your preferred command line interface, which we'll call your shell from now on.
1. Clone this repository:
```shell
git clone {{ thePayload.repository.clone_url }}
```
1. Navigate to the repository in your shell:
```shell
cd {{ thePayload.repository.name }}
```
1. Checkout to the branch in this pull request:
```shell
git checkout add-headers
```
1. In your text editor of choice, open the file called `01-name.md`, in the `_includes` directory. On the first line, replace the text with your name, and add a `#` before the content to make it an H1 Header.
1. Save your file. Every time you make changes, it's a good idea to type `git status`. You should type this after you stage files, and after you commit. It's always a good idea!
1. Stage your file:
```shell
git add _includes/01-name.md
```
1. Commit the change and add a commit message:
```shell
git commit -m "<YOUR MESSAGE>"
```
1. Push your new commit to GitHub:
```shell
git push
```
{% else %}
1. In this pull request, click the **Files changed** tab.
1. In the upper right corner of the file view, click the **small pencil** ✏️ icon for the file titled `_includes/01-name.md`.
1. On the **Edit file** tab, add a `#` before the content to make it an H1 Header. You can add more headers, using one to six `#` characters.
1. Above your new content, click **Preview changes**.
1. At the bottom of the page, type a short, meaningful commit message that describes the change you made to the file.
1. Click **Commit changes**.
{% endif %}

<hr>
<h3 align="center">Watch below for my response</h3>
<h3 align="center">Watch below for my response.</h3>
10 changes: 0 additions & 10 deletions responses/03-pr-succeeds.md

This file was deleted.

14 changes: 0 additions & 14 deletions responses/03-request-changes.md

This file was deleted.

Loading

0 comments on commit dcd4433

Please sign in to comment.