diff --git a/README.md b/README.md index f69f3ef597e..c54e474bf7f 100644 --- a/README.md +++ b/README.md @@ -1,38 +1,9 @@ -# GitHub Guides +# Open Source Handbook -[GitHub Guides](https://guides.github.com/) are highly approachable tutorials about a larger idea or product feature on GitHub. They not only explain how to accomplish a task, but also why you’d want to, and how that task fits into the larger story of using GitHub as a whole. +This handbook is a collection of resources to help individual, communities, and companies sustainably embrace open source software. It explains not only how to accomplish a task, but why you’d want to, and how that task fits into the larger story of consuming, contributing to, and producing open source software. -## What are the components that form a guide? +This handbook aims to foster healthy open source communities, and provide a canonical place for the community to discuss and codify best practices into highly-approachable resources. -For a deep-dive into the way a guide should be authored, take a look at the [GitHub Guides Content Model](https://manual-of-style.githubapp.com/guides-model) (another [GitHub Content Model](https://manual-of-style.githubapp.com/content-model) Joint). +## Contributing -## Other forms of user assistance - -**training.github.com/kit:** Materials for individuals who want to deliver full-length lessons about Git or GitHub. - -**help.github.com:** Discrete articles that get existing users unstuck and back to work (yes, Virginia - [there's a content model for that](https://manual-of-style.githubapp.com/help-model), too!). - -## Installation - -Clone this repository, then run some handy scripts to get going! - -``` -git clone https://github.com/github/guides -cd guides -script/setup -script/server -``` - -## Contributing a new guide - -[CONTRIBUTING.md](/CONTRIBUTING.md) has everything you need to know to propose a new guide (or an update to an existing one!). - -## Deployment - -Deploying to production is as simple as merging your branch into the `gh-pages` branch. :tada: - -Deploying to staging requires a Chat account and Hubot. Run `.deploy guides/YOUR-BRANCH to staging` just like you normally would and visit https://guides-staging.githubapp.com to preview your changes! - -## Questions? - -Ping the **@github/guides team** (or just pop into **+The Guides Room** in good old Campfire - we'll dazzle you with random emoji :peach::fuelpump:). +This handbook aims to reflect community best practices. Check out [CONTRIBUTING.md](/CONTRIBUTING.md) for ways to offer feedback and contribute.