From 6e57633b93d80f047ea6333f6a109907c05909ce Mon Sep 17 00:00:00 2001 From: Briana Swift Date: Tue, 12 May 2020 12:09:20 +0200 Subject: [PATCH 1/9] update README for open source --- README.md | 18 +++++++++++++++++- 1 file changed, 17 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 4ad9f9a7a..e3ad7b225 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,19 @@ [![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-v2.0%20adopted-ff69b4.svg)](code_of_conduct.md) -Welcome to the GitHub Training Manual repo. In this repo, you will find the content used by GitHub trainers during our official training courses and scripts used when teaching. +Welcome to the GitHub Training Manual repository. In this repository, you will find the content used by GitHub trainers during our official GitHub for Developer training courses and the scripts used when teaching. + +The content is all written in markdown, and the scripts are shell scripts. + +## Technologies used + +This manual is served using GitHub Pages and [docsify](https://docsify.js.org), and can be found at [githubtraining.github.io/training-manual](https://githubtraining.github.io/training-manual/#/). + +## Goals and scope + +The goal of this project is to serve as a content source for in person trainings on Git and GitHub. While GitHub, select GitHub Partners, and select customers may have their own use case directly with GitHub, the content is open source so we can share and improve as a community. You can find more information on contributing in the [contributing guide](CONTRIBUTING.md). + +The topic scope is limited to GitHub's core product features, on GitHub.com and also for GitHub Enterprise users. ## Deploy the manual @@ -52,3 +64,7 @@ Docsify doesn't currently support creating PDFs, but you can generate one using ## Teaching scripts Scripts that accompany the manual, and their documentation can be found in the [`script/`](script/) directory. + +## License + +Please see the [license](LICENSE) for detailed information. When using the GitHub logos, be sure to follow the [GitHub logo guidelines](https://github.com/logos). \ No newline at end of file From 71a775ec5304da30bc21d61bc11cf9ca3b66b0d5 Mon Sep 17 00:00:00 2001 From: Briana Swift Date: Wed, 20 May 2020 10:14:56 +0200 Subject: [PATCH 2/9] more accurate description in README Co-authored-by: Parker Brown <17183625+parkerbxyz@users.noreply.github.com> --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index e3ad7b225..0fa2ca193 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ [![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-v2.0%20adopted-ff69b4.svg)](code_of_conduct.md) -Welcome to the GitHub Training Manual repository. In this repository, you will find the content used by GitHub trainers during our official GitHub for Developer training courses and the scripts used when teaching. +Welcome to the GitHub Training Manual repository. In this repository, you will find the content used by GitHub trainers during our official GitHub training courses and the scripts used when teaching. The content is all written in markdown, and the scripts are shell scripts. @@ -67,4 +67,4 @@ Scripts that accompany the manual, and their documentation can be found in the [ ## License -Please see the [license](LICENSE) for detailed information. When using the GitHub logos, be sure to follow the [GitHub logo guidelines](https://github.com/logos). \ No newline at end of file +Please see the [license](LICENSE) for detailed information. When using the GitHub logos, be sure to follow the [GitHub logo guidelines](https://github.com/logos). From e8a71014aa8801b2533396d4b391b7ee8c6b632a Mon Sep 17 00:00:00 2001 From: Briana Swift Date: Wed, 20 May 2020 10:15:43 +0200 Subject: [PATCH 3/9] Update README.md Co-authored-by: Parker Brown <17183625+parkerbxyz@users.noreply.github.com> --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 0fa2ca193..23caa95eb 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,7 @@ This manual is served using GitHub Pages and [docsify](https://docsify.js.org), ## Goals and scope -The goal of this project is to serve as a content source for in person trainings on Git and GitHub. While GitHub, select GitHub Partners, and select customers may have their own use case directly with GitHub, the content is open source so we can share and improve as a community. You can find more information on contributing in the [contributing guide](CONTRIBUTING.md). +The goal of this project is to serve as a content source for training on Git and GitHub. While GitHub, select GitHub Partners, and select customers may have their own use case directly with GitHub, the content is open source so we can share and improve as a community. You can find more information on contributing in the [contributing guide](CONTRIBUTING.md). The topic scope is limited to GitHub's core product features, on GitHub.com and also for GitHub Enterprise users. From cb83032b4c54394df0d74cdbc663a53bdc4a7834 Mon Sep 17 00:00:00 2001 From: Briana Swift Date: Wed, 20 May 2020 10:17:41 +0200 Subject: [PATCH 4/9] link to markdown docs --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 23caa95eb..53183abb0 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ Welcome to the GitHub Training Manual repository. In this repository, you will find the content used by GitHub trainers during our official GitHub training courses and the scripts used when teaching. -The content is all written in markdown, and the scripts are shell scripts. +The content is all written in [markdown](https://github.github.com/gfm/), and the scripts are shell scripts. ## Technologies used From 817d2d76bc99b5983abc0f56392f67e5427427d1 Mon Sep 17 00:00:00 2001 From: Briana Swift Date: Wed, 20 May 2020 10:19:24 +0200 Subject: [PATCH 5/9] add new line to try to please the linter gods --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 53183abb0..2e1333d82 100644 --- a/README.md +++ b/README.md @@ -68,3 +68,4 @@ Scripts that accompany the manual, and their documentation can be found in the [ ## License Please see the [license](LICENSE) for detailed information. When using the GitHub logos, be sure to follow the [GitHub logo guidelines](https://github.com/logos). + From 788505be719467bffe3ac9d864fd224bd64cca25 Mon Sep 17 00:00:00 2001 From: Briana Swift Date: Wed, 20 May 2020 10:21:36 +0200 Subject: [PATCH 6/9] remove extra line to try to please linter gods --- README.md | 1 - 1 file changed, 1 deletion(-) diff --git a/README.md b/README.md index 2e1333d82..53183abb0 100644 --- a/README.md +++ b/README.md @@ -68,4 +68,3 @@ Scripts that accompany the manual, and their documentation can be found in the [ ## License Please see the [license](LICENSE) for detailed information. When using the GitHub logos, be sure to follow the [GitHub logo guidelines](https://github.com/logos). - From 9f4b6e5e74b813d590eed3c83b302030194d027e Mon Sep 17 00:00:00 2001 From: Parker Brown <17183625+parkerbxyz@users.noreply.github.com> Date: Fri, 29 May 2020 17:23:25 -0400 Subject: [PATCH 7/9] Remove "GitHub for Developers" from title --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 53183abb0..18222326d 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# GitHub Training Manual: GitHub for Developers +# GitHub Training Manual [![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-v2.0%20adopted-ff69b4.svg)](code_of_conduct.md) From b5789b98d019290a365d95398d96560c2c84e606 Mon Sep 17 00:00:00 2001 From: Parker Brown <17183625+parkerbxyz@users.noreply.github.com> Date: Fri, 29 May 2020 17:24:53 -0400 Subject: [PATCH 8/9] Apply suggestions from code review --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 18222326d..bc6fa60cf 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ [![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-v2.0%20adopted-ff69b4.svg)](code_of_conduct.md) -Welcome to the GitHub Training Manual repository. In this repository, you will find the content used by GitHub trainers during our official GitHub training courses and the scripts used when teaching. +Welcome to the GitHub Training Manual repository. In this repository, you will find the content used by the [GitHub Professional Services](https://services.github.com/) team during our official GitHub training courses and the scripts used when teaching. The content is all written in [markdown](https://github.github.com/gfm/), and the scripts are shell scripts. @@ -67,4 +67,4 @@ Scripts that accompany the manual, and their documentation can be found in the [ ## License -Please see the [license](LICENSE) for detailed information. When using the GitHub logos, be sure to follow the [GitHub logo guidelines](https://github.com/logos). +Please see the [license](LICENSE) for detailed information. When using the GitHub logos, be sure to follow the [GitHub Logos and Usage](https://github.com/logos) guidelines. From 862635d7641845a11faca68fbb6abbd86add5d4f Mon Sep 17 00:00:00 2001 From: Parker Brown <17183625+parkerbxyz@users.noreply.github.com> Date: Wed, 10 Jun 2020 11:24:27 -0400 Subject: [PATCH 9/9] Update Markdown link --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index bc6fa60cf..23234f603 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ Welcome to the GitHub Training Manual repository. In this repository, you will find the content used by the [GitHub Professional Services](https://services.github.com/) team during our official GitHub training courses and the scripts used when teaching. -The content is all written in [markdown](https://github.github.com/gfm/), and the scripts are shell scripts. +The content is all written in [Markdown](https://guides.github.com/features/mastering-markdown/), and the scripts are shell scripts. ## Technologies used