|
1 | | -# GitHub Docs <!-- omit in toc --> |
| 1 | +# 📚 GitHub Docs |
2 | 2 |
|
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). |
| 3 | +Welcome to the **GitHub Docs** repository! |
4 | 4 |
|
| 5 | +GitHub's documentation is open source, allowing both GitHub employees and the open-source community to contribute. If you'd like to improve the documentation, fix issues, or add new content, you're welcome to participate. |
5 | 6 |
|
6 | | -## Quick links by contributor type |
| 7 | +👉 **Start here:** https://docs.github.com/en/contributing |
7 | 8 |
|
8 | | -* **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 | +--- |
9 | 10 |
|
10 | | -* **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 | +## 🚀 Contributor Guides |
11 | 12 |
|
12 | | -## How we sync changes across Docs repositories |
| 13 | +Choose the guide that matches your role: |
13 | 14 |
|
14 | | -There are two GitHub Docs repositories: |
| 15 | +### 👥 GitHub Employees (Hubbers) |
15 | 16 |
|
16 | | -- **`github/docs`** (public): Open to external contributions |
| 17 | +See the `CONTRIBUTING.md` file in the **docs-content** repository for GitHub-specific development workflows and internal processes. |
17 | 18 |
|
18 | | -- **`github/docs-internal`** (private): For GitHub employee contributions. |
| 19 | +- https://github.com/github/docs-content/blob/main/CONTRIBUTING.md |
19 | 20 |
|
20 | | -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 | +### 🌍 Open Source Contributors |
21 | 22 |
|
22 | | -**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 | +If you're contributing from the community, follow the quick-start guide in the **docs** repository. |
23 | 24 |
|
24 | | -## New to contributing |
| 25 | +- https://github.com/github/docs/blob/main/.github/CONTRIBUTING.md |
25 | 26 |
|
26 | | -Here are some resources to help you get started with open source contributions: |
| 27 | +--- |
27 | 28 |
|
28 | | -* [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) |
29 | | -* [Set up Git](https://docs.github.com/en/get-started/git-basics/set-up-git) |
30 | | -* [GitHub flow](https://docs.github.com/en/get-started/using-github/github-flow) |
31 | | -* [Collaborating with pull requests](https://docs.github.com/en/github/collaborating-with-pull-requests) |
| 29 | +## 🔄 Repository Structure |
32 | 30 |
|
33 | | -## License |
| 31 | +GitHub Docs is maintained across two repositories: |
34 | 32 |
|
35 | | -This project is dual-licensed under: |
| 33 | +| Repository | Visibility | Purpose | |
| 34 | +|------------|------------|---------| |
| 35 | +| `github/docs` | 🌐 Public | Accepts community contributions | |
| 36 | +| `github/docs-internal` | 🔒 Private | Used by GitHub employees | |
36 | 37 |
|
37 | | -* **Creative Commons Attribution 4.0** - for documentation and content in the assets, content, and data folders (see [LICENSE](LICENSE)) |
38 | | -* **MIT License** - for code (see [LICENSE-CODE](LICENSE-CODE)) |
| 38 | +Both repositories synchronize regularly, so content updates made in one are reflected in the other. |
| 39 | + |
| 40 | +> **Note** |
| 41 | +> |
| 42 | +> The public `github/docs` repository only accepts documentation-related contributions, including: |
| 43 | +> |
| 44 | +> - Markdown files (`/content`) |
| 45 | +> - Supported `/data` files (such as reusable content) |
| 46 | +> |
| 47 | +> Infrastructure, workflows, build scripts, and site-generation code are maintained internally and aren't open to external contributions. |
| 48 | +
|
| 49 | +--- |
| 50 | + |
| 51 | +## 🌱 New to Open Source? |
| 52 | + |
| 53 | +These resources will help you get started: |
| 54 | + |
| 55 | +- 📖 Finding ways to contribute to open source |
| 56 | + https://docs.github.com/en/get-started/exploring-projects-on-github/finding-ways-to-contribute-to-open-source-on-github |
| 57 | + |
| 58 | +- ⚙️ Set up Git |
| 59 | + https://docs.github.com/en/get-started/git-basics/set-up-git |
| 60 | + |
| 61 | +- 🌿 GitHub Flow |
| 62 | + https://docs.github.com/en/get-started/using-github/github-flow |
| 63 | + |
| 64 | +- 🔀 Collaborating with Pull Requests |
| 65 | + https://docs.github.com/en/github/collaborating-with-pull-requests |
| 66 | + |
| 67 | +--- |
| 68 | + |
| 69 | +## 📄 License |
| 70 | + |
| 71 | +This project is dual licensed. |
| 72 | + |
| 73 | +### 📚 Documentation |
| 74 | + |
| 75 | +Content in the `assets`, `content`, and `data` directories is licensed under the **Creative Commons Attribution 4.0 International (CC BY 4.0)** License. |
| 76 | + |
| 77 | +See: `LICENSE` |
| 78 | + |
| 79 | +### 💻 Source Code |
| 80 | + |
| 81 | +All code in this repository is licensed under the **MIT License**. |
| 82 | + |
| 83 | +See: `LICENSE-CODE` |
| 84 | + |
| 85 | +--- |
| 86 | + |
| 87 | +## ❤️ Thank You |
| 88 | + |
| 89 | +Every contribution—whether it's fixing a typo, improving existing documentation, or writing new content—helps make GitHub Docs better for millions of developers worldwide. |
| 90 | + |
| 91 | +Happy contributing! 🎉 |
0 commit comments