|
1 | 1 | # GitHub Docs <!-- omit in toc --> |
2 | | -[](https://github.com/codespaces/new/?repo=github) |
3 | 2 |
|
4 | | -This repository contains the documentation website code and Markdown source files for [docs.github.com](https://docs.github.com). |
| 3 | +Welcome to GitHub Docs! GitHub’s documentation is open source, meaning anyone from inside or outside the company can contribute. For full contributing guidelines, visit our [contributing guide](https://docs.github.com/en/contributing) |
5 | 4 |
|
6 | | -GitHub's Docs team works on pre-production content in a private repo that regularly syncs with this public repo. |
| 5 | +## Quick links by contributor type |
7 | 6 |
|
8 | | -Use the table of contents icon <img alt="Table of contents icon" src="./contributing/images/table-of-contents.png" width="25" height="25" /> on the top right corner of this document to navigate to a specific section quickly. |
| 7 | +* **Hubbers (GitHub employees):** See [CONTRIBUTING.md](https://github.com/github/docs-content/blob/main/CONTRIBUTING.md) in the `docs-content` repository for GitHub-specific processes. |
9 | 8 |
|
10 | | -## Contributing |
| 9 | +* **Open source contributors:** See [CONTRIBUTING.md](https://github.com/github/docs/blob/main/.github/CONTRIBUTING.md) in the `docs` repository for a quick-start summary. |
11 | 10 |
|
12 | | -We accept different types of contributions, including some that don't require you to write a single line of code. For detailed instructions on how to get started with our project, see [About contributing to GitHub Docs](https://docs.github.com/en/contributing/collaborating-on-github-docs/about-contributing-to-github-docs). |
| 11 | +## How we sync changes across Docs repositories |
13 | 12 |
|
14 | | -### Ways to contribute |
| 13 | +There are two GitHub Docs repositories: |
15 | 14 |
|
16 | | -On the GitHub Docs site, you can contribute by clicking the **Make a contribution** button at the bottom of the page to open a pull request for quick fixes like typos, updates, or link fixes. |
| 15 | +- **`github/docs`** (public): Open to external contributions |
17 | 16 |
|
18 | | -You can also contribute by creating a local environment or opening a Codespace. For more information, see [Setting up your environment to work on GitHub Docs](https://docs.github.com/en/contributing/setting-up-your-environment-to-work-on-github-docs). |
| 17 | +- **`github/docs-internal`** (private): For GitHub employee contributions. |
19 | 18 |
|
20 | | -<img alt="Contribution call-to-action" src="./contributing/images/contribution_cta.png" width="400"> |
| 19 | +The two repositories sync frequently. Content changes in one are reflected in the other. Hubbers might prefer to post in `docs` when working with a customer, but `docs` has limitations on the types of contributions it accepts to safeguard the site and our workflows. Internal contributions should usually go to `docs-internal`. |
21 | 20 |
|
22 | | -For more complex contributions, please [open an issue in the docs-content repo](https://github.com/github/docs-content/issues/new/choose) describing the changes you'd like to see. |
| 21 | +**Important:** The `docs` repository accepts contributions to content files (`.md` files in `/content` and select `/data` sections like reusables only). Infrastructure files, workflows, and site-building code are not open for external modification. |
23 | 22 |
|
24 | | -If you're looking for a way to contribute, you can scan through our [help wanted board](https://github.com/github/docs/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22) to find open issues already approved for work. |
| 23 | +## New to contributing |
25 | 24 |
|
26 | | -### And that's it! |
| 25 | +Here are some resources to help you get started with open source contributions: |
27 | 26 |
|
28 | | -If you're having trouble with your GitHub account, contact [Support](https://support.github.com). |
29 | | - |
30 | | -That's how you can easily become a member of the GitHub Docs community. :sparkles: |
31 | | - |
32 | | -## READMEs |
33 | | - |
34 | | -In addition to the README you're reading right now, this repo includes other READMEs that describe the purpose of each subdirectory in more detail: |
35 | | - |
36 | | -- [content/README.md](content/README.md) |
37 | | -- [content/graphql/README.md](content/graphql/README.md) |
38 | | -- [content/rest/README.md](content/rest/README.md) |
39 | | -- [contributing/README.md](contributing/README.md) |
40 | | -- [data/README.md](data/README.md) |
41 | | -- [data/reusables/README.md](data/reusables/README.md) |
42 | | -- [data/variables/README.md](data/variables/README.md) |
43 | | -- [src/README.md](src/README.md) |
44 | | - |
45 | | -## License |
46 | | - |
47 | | -The GitHub product documentation in the assets, content, and data folders are licensed under a [CC-BY license](LICENSE). |
48 | | - |
49 | | -All other code in this repository is licensed under the [MIT license](LICENSE-CODE). |
50 | | - |
51 | | -When using the GitHub logos, be sure to follow the [GitHub logo guidelines](https://github.com/logos). |
52 | | - |
53 | | -## Thanks :purple_heart: |
54 | | - |
55 | | -Thanks for all your contributions and efforts towards improving the GitHub documentation. We thank you for being part of our :sparkles: community :sparkles:! |
| 27 | +* [Finding ways to contribute to open source on GitHub](https://docs.github.com/en/get-started/exploring-projects-on-github/finding-ways-to-contribute-to-open-source-on-github) |
| 28 | +* [Set up Git](https://docs.github.com/en/get-started/git-basics/set-up-git) |
| 29 | +* [GitHub flow](https://docs.github.com/en/get-started/using-github/github-flow) |
| 30 | +* [Collaborating with pull requests](https://docs.github.com/en/github/collaborating-with-pull-requests) |
0 commit comments