Skip to content

Commit bdcfa92

Browse files
authored
Merge pull request #21 from mapzen/rmglennon-patch-1
Delete everything from readme, link to copy of files
2 parents 6690a8e + f4e39ba commit bdcfa92

File tree

1 file changed

+2
-51
lines changed

1 file changed

+2
-51
lines changed

README.md

Lines changed: 2 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -1,52 +1,3 @@
1-
# Tutorial: Learn GitHub by building a website
1+
This repository is deprecated. It previously contained files for a tutorial hosted on mapzen.com.
22

3-
This repository contains the files used with Mapzen's GitHub tutorial at https://mapzen.com/documentation/guides/github-tutorial/.
4-
5-
## GitHub for Documentation
6-
7-
This tutorial was originally presented at 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. The tutorial was later adapted into Mapzen's documentation set.
8-
9-
### Original workshop information
10-
11-
Presenter: Rhonda Glennon, [@rmglennon](https://github.com/rmglennon)
12-
13-
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.
14-
15-
In this hands-on workshop, you will:
16-
17-
- Get an introduction to the Git version control system, terminology, and the GitHub workflow.
18-
- Create a simple website with GitHub Pages and use GitHub for documentation.
19-
- Learn how you can support open-source projects by contributing documentation.
20-
21-
The session is designed for beginners to GitHub, but all levels are invited.
22-
23-
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.
24-
25-
## Resources from the presentation
26-
27-
Examples of github.io websites
28-
29-
- https://square.github.io/
30-
- https://microsoft.github.io/
31-
- https://disney.github.io/
32-
33-
Markdown syntax reference
34-
35-
- https://daringfireball.net/projects/markdown/
36-
37-
Training classes from GitHub
38-
39-
- https://services.github.com/training/
40-
- Includes free self-paced classes and webinars
41-
42-
GitHub branching and flow diagrams
43-
- Octopus Git branch: http://imgur.com/gallery/YG8In8X/new
44-
- GitHub Flow: https://guides.github.com/introduction/flow/
45-
46-
Examples of documentation repositories
47-
48-
- CircleCI has a repository with only documentation-related files: https://github.com/circleci/circleci-docs
49-
- Kubernetes repository contains both code and documentation files: https://github.com/kubernetes/kubernetes
50-
- Example pull request about documentation with team discussion: https://github.com/pelias/pelias-doc/pull/163
51-
52-
Make four pull requests by October 31, 2016 and get a free Hacktoberfest t-shirt: https://hacktoberfest.digitalocean.com/
3+
You can find a copy of the original instructions in https://github.com/rmglennon/write-the-docs.

0 commit comments

Comments
 (0)