Skip to content

Commit

Permalink
guide-ify all the things
Browse files Browse the repository at this point in the history
  • Loading branch information
Nadia Eghbal committed Oct 19, 2016
1 parent 187b8d5 commit dafb991
Show file tree
Hide file tree
Showing 11 changed files with 42 additions and 42 deletions.
16 changes: 8 additions & 8 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Contributing to this Handbook
# Contributing to this Guide

Thanks for checking out the Open Source Handbook! We're excited to hear and learn from you. Your experiences will benefit others who are reading and using this Handbook.
Thanks for checking out the Open Source Guide! We're excited to hear and learn from you. Your experiences will benefit others who are reading and using this Guide.

We've put together the following guidelines to help you figure out where you can best be helpful.

Expand All @@ -14,13 +14,13 @@ We've put together the following guidelines to help you figure out where you can
0. [Community](#community)

## Types of contributions we're looking for
First and foremost, this project is a forum to discuss open source best practices, then document them in the Handbook when we've found consensus. Your first contribution might be starting a new conversation, or adding to an existing conversation, around best practices. You can do so under [Issues](https://github.com/github/open-source-handbook/issues).
First and foremost, this project is a forum to discuss open source best practices, then document them in the Guide when we've found consensus. Your first contribution might be starting a new conversation, or adding to an existing conversation, around best practices. You can do so under [Issues](https://github.com/github/open-source-handbook/issues).

There are also many ways you can contribute to the Handbook directly:
There are also many ways you can contribute to the Guide directly:

* Fix editorial inconsistencies or inaccuracies
* Revise language to be more approachable and friendly
* Translate the Handbook into other languages
* Translate the Guide into other languages
* Add links to other case studies or examples that help illustrate a point (either inline, or under "Further Reading")
* Write a new article (please open an issue to discuss before writing!)

Expand All @@ -31,14 +31,14 @@ Interested in making a contribution? Read on!
Before we get started, here are a few things we expect from you (and that you should expect from others):

* Be kind and thoughtful in your conversations around this project. We all come from different backgrounds and projects, which means we likely have different perspectives on "how open source is done." Try to listen to others rather than convince them that your way is correct.
* This Handbook is released with a [Contributor Code of Conduct](./CODE_OF_CONDUCT.md). By participating in this project, you agree to abide by its terms.
* This Guide is released with a [Contributor Code of Conduct](./CODE_OF_CONDUCT.md). By participating in this project, you agree to abide by its terms.
* If you open a pull request, please ensure that your contribution passes all tests. If there are test failures, you will need to address them before we can merge your contribution.

## How to contribute

If you'd like to contribute, start by searching through the [issues](https://github.com/github/open-source-handbook/issues) and [pull requests](https://github.com/github/open-source-handbook/pulls) to see whether someone else has raised a similar idea or question.

If you don't see your idea listed, and you think it fits into the goals of this handbook, do one of the following:
If you don't see your idea listed, and you think it fits into the goals of this guide, do one of the following:
* **If your contribution is minor,** such as a typo fix, you can make the change and open a pull request.
* **If your contribution is major,** such as a new article or case study, start by opening an issue first. That way, other people can weigh in on the discussion before you do any work.

Expand All @@ -63,7 +63,7 @@ If you've been active on this project (such as writing helpful content, answerin

## Community

Handbook discussions take place on this repository's [Issues](https://github.com/github/open-source-handbook/issues) and [Pull Requests](https://github.com/github/open-source-handbook/pulls) sections. Anybody is welcome to join these conversations. There is also a [mailing list](
Discussions about this guide take place on this repository's [Issues](https://github.com/github/open-source-handbook/issues) and [Pull Requests](https://github.com/github/open-source-handbook/pulls) sections. Anybody is welcome to join these conversations. There is also a [mailing list](
http://eepurl.com/cecpnT) for regular updates.

Wherever possible, do not take these conversations to private channels, including contacting the maintainers directly. Keeping communication public means everybody can benefit and learn from the conversation.
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,20 @@
# Open Source Handbook
# Open Source Guide

A community handbook for open source creators. **[Check it out…](http://opensource.guide/)**
A community guide for open source creators. **[Check it out…](http://opensource.guide/)**

## Goals

The Open Source Handbook is a collection of resources for individuals, communities, and companies who want to learn how to run an open source project. It gives readers enough information to get started, but it doesn't attempt to answer everything in detail.
The Open Source Guide is a collection of resources for individuals, communities, and companies who want to learn how to run an open source project. It gives readers enough information to get started, but it doesn't attempt to answer everything in detail.

The Handbook follows these guiding principles:
The Guide follows these guiding principles:

* **Approachability:** Don't assume reader has prior knowledge
* **Brevity:** Keep it simple, link to outside content for deeper dives
* **Curation:** Amplify community best practices vs. any individual's point of view

This handbook was originally created and curated by GitHub, along with input from outside community reviewers, but it is not specific to GitHub products. Our goal is to aggregate community best practices, *not* what GitHub (or any other individual or entity) thinks is best. Therefore, we try to use examples and quotations from others to illustrate our points. Many sections also link to "Further Reading" at the end, to surface relevant perspectives elsewhere on the web.
This guide was originally created and curated by GitHub, along with input from outside community reviewers, but it is not specific to GitHub products. Our goal is to aggregate community best practices, *not* what GitHub (or any other individual or entity) thinks is best. Therefore, we try to use examples and quotations from others to illustrate our points. Many sections also link to "Further Reading" at the end, to surface relevant perspectives elsewhere on the web.

A big reason we started this project is because we felt that there weren't enough resources for people creating open source projects. We made the Handbook itself open source in hopes that you'll use this space to talk about best practices, then document them when you've found consensus. We'd like this to be a safe space to talk about what's hard, what's scary, and what's simply confusing about running open source projects.
A big reason we started this project is because we felt that there weren't enough resources for people creating open source projects. We made the Guide itself open source in hopes that you'll use this space to talk about best practices, then document them when you've found consensus. We'd like this to be a safe space to talk about what's hard, what's scary, and what's simply confusing about running open source projects.

## Roadmap

Expand All @@ -40,13 +40,13 @@ This means you can use the code and content in this repository except for GitHub

When you contribute to this repository you are doing so under the above licenses.

Screenshots in the handbook are used according to [various permissions](notices.md#permissions).
Screenshots in the guide are used according to [various permissions](notices.md#permissions).

## Acknowledgments

The initial release of the Handbook was authored by **@nayafia, @bkeepers, @stephbwills,** and **@mlinksva**.
The initial release of the Guide was authored by **@nayafia, @bkeepers, @stephbwills,** and **@mlinksva**.

Thanks to **@aitchabee, @benbalter, @brettcannon, @coralineada, @dmleong, @ericholscher, @gr2m, @janl, @jfrazelle, @joshsimmons, @kytrinyx, @lee-dohm, @mikeal, @mikemcquaid, @nathansobo, @nsqe, @orta, @parkr, @shazow, @steveklabnik,** and **@wooorm** for lending their valuable input and expertise leading up to the initial release, and to **@sophshep** for designing the Handbook.
Thanks to **@aitchabee, @benbalter, @brettcannon, @coralineada, @dmleong, @ericholscher, @gr2m, @janl, @jfrazelle, @joshsimmons, @kytrinyx, @lee-dohm, @mikeal, @mikemcquaid, @nathansobo, @nsqe, @orta, @parkr, @shazow, @steveklabnik,** and **@wooorm** for lending their valuable input and expertise leading up to the initial release, and to **@sophshep** for designing the Guide.

## Disclaimer
While we've got advice about running an open source project, we're not lawyers. Be sure to read our [disclaimer](notices.md#legal-disclaimer) before diving in.
6 changes: 3 additions & 3 deletions _config.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
title: "Open Source Handbook"
description: "A community handbook for open source creators."
title: "Open Source Guide"
description: "A community guide for open source creators."

exclude:
- bin
Expand Down Expand Up @@ -33,7 +33,7 @@ gems:
- jekyll-octicons
- jekyll-seo-tag
- jekyll-sitemap

branch: gh-pages

github:
Expand Down
2 changes: 1 addition & 1 deletion _layouts/default.html
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
</div>
<div class="d-table-cell v-align-middle text-white">
<h1 class="m-0 my-md-3 pr-3 d-sm-inline-block text-gamma">
<a href='{{ "/" | prepend: site.baseurl }}' class="link-unstyled">Open Source Handbook</a>
<a href='{{ "/" | prepend: site.baseurl }}' class="link-unstyled">Open Source Guide</a>
</h1>
<a href="https://github.com/{{ site.github.repository_nwo }}" class="text-small">
View on GitHub {% octicon arrow-right height:20 class:"v-align-middle ml-1 fill-white" aria-label:hi %}
Expand Down
2 changes: 1 addition & 1 deletion bower.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "open-source-handbook",
"description": "This handbook is a collection of resources to help individuals, 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.",
"description": "This guide is a collection of resources to help individuals, 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.",
"main": "script/server",
"authors": [
"GitHub",
Expand Down
10 changes: 5 additions & 5 deletions docs/content-model.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Content Model

The Open Source Handbook helps individuals, communities, and companies 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.
The Open Source Guide helps individuals, communities, and companies 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.

This content is created and curated by GitHub, and covers topics that are very relevant to GitHub users, but it is not specific to GitHub products.

Expand Down Expand Up @@ -54,20 +54,20 @@ Introductions are a delicate balance between showing and telling. Don't *tell* t

We never want to leave a user at a dead end, especially in situations where we leave out nuance in pursuit of accessibility. Every piece of content should link to any related information. If another good resource exists on the internet, link to it. Some examples include:

- Related content in the handbook
- Related content in the guide
- GitHub Help content for more details on _how_ to do something.
- Projects on GitHub that illustrate the introduced concepts.
- External blog posts, articles, or resources

### Credits

In the spirit of open source, this handbook aims to reuse good content that already exists and is licensed for reuse, even if it requires heavy editing to match the structure and style of the handbook.
In the spirit of open source, this guide aims to reuse good content that already exists and is licensed for reuse, even if it requires heavy editing to match the structure and style of the guide.

Each piece of content should include attribution for any content that it was inspired by or derived from. The content must be published with an explicit license that allows reuse for commercial purposes (CC0, CC-BY, CC-BY-SA are all acceptable).

## Content Types

The handbook contains a few types of content:
The guide contains a few types of content:

- [Conceptual](#conceptual-content)
- [Tactical](#tactical-content)
Expand All @@ -88,7 +88,7 @@ Conceptual content is structured as:

### Tactical Content

Tactical content answers the question "How?". This is arguably the most common type of content developed for the handbook because it is meant to describe best practices in open source. This content should explain the steps necessary to achieve a single goal. If there is not a community best practice, it should give an overview of a few approaches and reference other tactical content for details.
Tactical content answers the question "How?". This is arguably the most common type of content developed for the guide because it is meant to describe best practices in open source. This content should explain the steps necessary to achieve a single goal. If there is not a community best practice, it should give an overview of a few approaches and reference other tactical content for details.

Tactical content is structured as:

Expand Down
2 changes: 1 addition & 1 deletion docs/personas.md
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,7 @@

* Can we use language that applies to both code- and non-code-centric projects?

* If we don't tailor the handbook to them, will they feel isolated or ignored? Is there anything we'd miss about their experience?
* If we don't tailor the guide to them, will they feel isolated or ignored? Is there anything we'd miss about their experience?

* Student developer

Expand Down
16 changes: 8 additions & 8 deletions docs/roadmap.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,24 @@
# Roadmap

Our vision for the Open Source Handbook is to provide a jumping off point for individuals, communities, and companies to sustainably embrace open source.
Our vision for the Open Source Guide is to provide a jumping off point for individuals, communities, and companies to sustainably embrace open source.

### 2016: Creators

We started by focusing on open source creators, because they play a critical role in growing healthy projects. Creators help set good examples for contributors and consumers of open source. We also noticed there were very few comprehensive resources aimed at helping creators.

* [x] Create a handbook that helps creators start and grow their own open source project
* [x] Make the handbook public and release it as an open source project
* [x] Create a guide that helps creators start and grow their own open source project
* [x] Make the guide public and release it as an open source project
* [ ] Continue to improve the content for open source creators
* [ ] Foster healthy community dynamics so the handbook becomes a place to codify community best practices
* [ ] Improve the discoverability of the Handbook for open source creators
* [ ] Foster healthy community dynamics so the guide becomes a place to codify community best practices
* [ ] Improve the discoverability of the guide for open source creators

### 2017: Contributors & Consumers

* [ ] Move the [Contributing to Open Source on GitHub](https://guides.github.com/activities/contributing-to-open-source/) guide to the handbook, and expand it to include community best practices for contributors.
* [ ] Expand the handbook to include content for open source consumers.
* [ ] Move the [Contributing to Open Source on GitHub](https://guides.github.com/activities/contributing-to-open-source/) guide to the guide, and expand it to include community best practices for contributors.
* [ ] Expand the guide to include content for open source consumers.

### Beyond

Open source is complicated, especially for newcomers. But the community has learned many lessons about the best way to use, contribute to, and produce open source software. Everyone shouldn't have to learn those lessons the hard way. To give it more prominence, we want to move it from http://opensource.guide to a permanent home on https://github.com/open-source, where it will live along side features and programs that help individuals, communities, and companies sustainably embrace open source. The content will remain open source for anyone to use.

This is our current plan. As with everything in this handbook, it is open to community feedback.
This is our current plan. As with everything in this guide, it is open to community feedback.
4 changes: 2 additions & 2 deletions index.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@
---

<div class="container-narrow text-center landing-intro">
<h1>Welcome to the Open Source Handbook!</h1>
<h1>Welcome to the Open Source Guide!</h1>
<p class="mb-md-5 lead">
If you're interested in launching and growing your own open source project, this is the handbook for you.
If you're interested in launching and growing your own open source project, this is the guide for you.
</p>
<a href="https://github.com/{{ site.github.repository_nwo }}">View on GitHub {% octicon arrow-right height:26 class:"v-align-middle ml-2 fill-maroon" aria-label:hi %}</a>
</div>
Expand Down
6 changes: 3 additions & 3 deletions notices.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@ title: Legal Disclaimer and Notices

## Legal Disclaimer

GitHub is not a law firm. As such, GitHub does not provide legal advice. The material in this handbook does not constitute legal advice nor does contributing to the handbook or communicating with GitHub or other contributors about the handbook create an attorney-client relationship.
GitHub is not a law firm. As such, GitHub does not provide legal advice. The material in this guide does not constitute legal advice nor does contributing to the guide or communicating with GitHub or other contributors about the guide create an attorney-client relationship.

Open source projects are made available and contributed to under licenses that include terms that, for the protection of contributors, make clear that the projects are offered "as-is", without warranty, and disclaiming liability for damages resulting from using the projects. This handbook is no different. The open content license it is offered under [includes such terms](https://creativecommons.org/licenses/by/4.0/legalcode#s5).
Open source projects are made available and contributed to under licenses that include terms that, for the protection of contributors, make clear that the projects are offered "as-is", without warranty, and disclaiming liability for damages resulting from using the projects. This guide is no different. The open content license it is offered under [includes such terms](https://creativecommons.org/licenses/by/4.0/legalcode#s5).

Running an open source project, like any human endeavor, involves uncertainty and trade-offs. We hope this handbook helps, but it may include mistakes, and can't address every situation. If you have any questions about your project, we encourage you to do your own research, seek out experts, and discuss with your community. If you have any legal questions, you should consult with your own legal counsel before moving forward. If you're at a company, [talk to its legal team](../getting-started/legal/#what-does-my-companys-legal-team-need-to-know).
Running an open source project, like any human endeavor, involves uncertainty and trade-offs. We hope this guide helps, but it may include mistakes, and can't address every situation. If you have any questions about your project, we encourage you to do your own research, seek out experts, and discuss with your community. If you have any legal questions, you should consult with your own legal counsel before moving forward. If you're at a company, [talk to its legal team](../getting-started/legal/#what-does-my-companys-legal-team-need-to-know).

## Licenses

Expand Down
Loading

0 comments on commit dafb991

Please sign in to comment.