Skip to content

Commit ebca2b5

Browse files
authored
Merge pull request #10 from mapzen/add-workshop-recap
Add section for the workshop overview and resources
2 parents e4e6691 + 1bc383a commit ebca2b5

File tree

1 file changed

+39
-6
lines changed

1 file changed

+39
-6
lines changed

README.md

Lines changed: 39 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,46 @@
11
# Write the Docs SF workshop
22

3-
Files for the GitHub for Documentation workshop for Write the Docs - San Francisco.
3+
This repository contains the files used in the GitHub for Documentation workshop from [Write the Docs - San Francisco](https://www.meetup.com/Write-the-Docs-SF/events/234679051/) on October 27, 2016.
44

5-
https://www.meetup.com/Write-the-Docs-SF/events/234679051/
5+
Presenter: Rhonda Glennon, [@rmglennon](https://github.com/rmglennon)
66

7-
To work through the tutorial, start with [tutorial-learn-github-pages.md](tutorial-learn-github-pages.md).
7+
To work through the tutorial presented in the workshop, start with [tutorial-learn-github-pages.md](tutorial-learn-github-pages.md).
88

9-
Presented on October 27, 2016
9+
## Workshop summary: GitHub for Documentation
1010

11-
Rhonda Glennon
11+
GitHub enables people to collaborate on projects, and many organizations use it for managing both software code and documentation. At this Write the Docs, you will get started with GitHub by applying its tools to building a documentation website.
1212

13-
@rmglennon
13+
In this hands-on workshop, you will:
14+
15+
- Get an introduction to the Git version control system, terminology, and the GitHub workflow.
16+
- Create a simple website with GitHub Pages and use GitHub for documentation.
17+
- Learn how you can support open-source projects by contributing documentation.
18+
19+
The session is designed for beginners to GitHub, but all levels are invited.
20+
21+
Bring your laptop so you can follow along with the presentation. Any operating system will work, and you need only a browser. If you are new to GitHub, create a free, personal account at https://github.com/join before arriving to save time.
22+
23+
## Resources from the presentation
24+
25+
Examples of github.io websites
26+
27+
- https://square.github.io/
28+
- https://microsoft.github.io/
29+
- https://disney.github.io/
30+
31+
Markdown syntax reference
32+
33+
- https://daringfireball.net/projects/markdown/
34+
35+
Training classes from GitHub
36+
37+
- https://services.github.com/training/
38+
- Includes free self-paced classes and webinars
39+
40+
Examples of documentation repositories
41+
42+
- CircleCI has a repository with only documentation-related files: https://github.com/circleci/circleci-docs
43+
- Kubernetes repository contains both code and documentation files: https://github.com/kubernetes/kubernetes
44+
- Example pull request about documentation with team discussion: https://github.com/pelias/pelias-doc/pull/163
45+
46+
Make four pull requests by October 31, 2016 and get a free Hacktoberfest t-shirt: https://hacktoberfest.digitalocean.com/

0 commit comments

Comments
 (0)