From 775614b6e6a19d2df4a2b0b99c4ef97dabb3504f Mon Sep 17 00:00:00 2001 From: Simontrinh0911 Date: Mon, 29 Aug 2022 23:04:40 +0200 Subject: [PATCH 1/5] Update README.md --- README.md | 40 +++++++++++++++------------------------- 1 file changed, 15 insertions(+), 25 deletions(-) diff --git a/README.md b/README.md index fbbaf2e15695..d050c504d36f 100644 --- a/README.md +++ b/README.md @@ -1,61 +1,51 @@ # GitHub Docs - This repository contains the documentation website code and Markdown source files for [docs.github.com](https://docs.github.com). - GitHub's Docs team works on pre-production content in a private repo that regularly syncs with this public repo. - Use the table of contents icon on the top left corner of this document to get to a specific section of this guide quickly. - ## Contributing - See [the contributing guide](CONTRIBUTING.md) for detailed instructions on how to get started with our project. -We accept different [types of contributions](https://github.com/github/docs/blob/main/contributing/types-of-contributions.md), including some that don't require you to write a single line of code. + We accept different [types of contributions](https://github.com/github/docs/blob/main/contributing/types-of-contributions.md), including some that don't require you to write a single line of code. -On the GitHub Docs site, you can click 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. + On the GitHub Docs site, you can click the make a contribution button to open a pull request for quick fixes like typos, updates, or link fixes. - + -For more complex contributions, you can open an issue using the most appropriate [issue template](https://github.com/github/docs/issues/new/choose) to describe the changes you'd like to see. + For more complex contributions, you can open an issue using the most appropriate [issue template](https://github.com/github/docs/issues/new/choose) to describe the changes you'd like to see. -If you're looking for a way to contribute, you can scan through our [existing issues](https://github.com/github/docs/issues) for something to work on. When ready, check out [Getting Started with Contributing](/CONTRIBUTING.md) for detailed instructions. + If you're looking for a way to contribute, you can scan through our [existing issues](https://github.com/github/docs/issues) for something to work on. When ready, check out [Getting Started with Contributing](/CONTRIBUTING.md) for detailed instructions. ### Join us in discussions - We use GitHub Discussions to talk about all sorts of topics related to documentation and this site. For example: if you'd like help troubleshooting a PR, have a great new idea, or want to share something amazing you've learned in our docs, join us in the [discussions](https://github.com/github/docs/discussions). - ### And that's it! - If you're having trouble with your GitHub account, contact [Support](https://support.github.com/contact). - That's how you can easily become a member of the GitHub Documentation community. :sparkles: + ## READMEs -## READMEs + 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: -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: - -- [content/README.md](content/README.md) -- [content/graphql/README.md](content/graphql/README.md) + - [content/README.md](content/README.md) + - [content/graphql/README.md](content/graphql/README.md) - [content/rest/README.md](content/rest/README.md) - [contributing/README.md](contributing/README.md) - [data/README.md](data/README.md) - [data/reusables/README.md](data/reusables/README.md) - [data/variables/README.md](data/variables/README.md) +- [includes/liquid-tags/README.md](includes/liquid-tags/README.md) +- [includes/README.md](includes/README.md) - [components/README.md](components/README.md) - [lib/liquid-tags/README.md](lib/liquid-tags/README.md) - [middleware/README.md](middleware/README.md) - [script/README.md](script/README.md) - [stylesheets/README.md](stylesheets/README.md) - [tests/README.md](tests/README.md) - ## License - The GitHub product documentation in the assets, content, and data folders are licensed under a [CC-BY license](LICENSE). -All other code in this repository is licensed under the [MIT license](LICENSE-CODE). + All other code in this repository is licensed under the [MIT license](LICENSE-CODE). -When using the GitHub logos, be sure to follow the [GitHub logo guidelines](https://github.com/logos). + When using the GitHub logos, be sure to follow the [GitHub logo guidelines](https://github.com/logos). -## Thanks :purple_heart: + ## Thanks :purple_heart: -Thanks for all your contributions and efforts towards improving the GitHub documentation. We thank you for being part of our :sparkles: community :sparkles:! +Thanks for all your contributions and efforts towards improving the GitHub documentation. We thank you being part of our :sparkles: community :sparkles: ! From 3d2e34eb241df53d6ca3414782b78f27cc4d7c12 Mon Sep 17 00:00:00 2001 From: Simontrinh0911 Date: Mon, 29 Aug 2022 23:10:38 +0200 Subject: [PATCH 2/5] Update README.md --- README.md | 76 +++++++++++++++++++++++++++---------------------------- 1 file changed, 38 insertions(+), 38 deletions(-) diff --git a/README.md b/README.md index d050c504d36f..75c418a0207d 100644 --- a/README.md +++ b/README.md @@ -1,51 +1,51 @@ # GitHub Docs -This repository contains the documentation website code and Markdown source files for [docs.github.com](https://docs.github.com). -GitHub's Docs team works on pre-production content in a private repo that regularly syncs with this public repo. -Use the table of contents icon on the top left corner of this document to get to a specific section of this guide quickly. -## Contributing -See [the contributing guide](CONTRIBUTING.md) for detailed instructions on how to get started with our project. + This repository contains the documentation website code and Markdown source files for [docs.github.com](https://docs.github.com). + GitHub's Docs team works on pre-production content in a private repo that regularly syncs with this public repo. + Use the table of contents icon on the top left corner of this document to get to a specific section of this guide quickly. + ## Contributing + See [the contributing guide](CONTRIBUTING.md) for detailed instructions on how to get started with our project. - We accept different [types of contributions](https://github.com/github/docs/blob/main/contributing/types-of-contributions.md), including some that don't require you to write a single line of code. + We accept different [types of contributions](https://github.com/github/docs/blob/main/contributing/types-of-contributions.md), including some that don't require you to write a single line of code. - On the GitHub Docs site, you can click the make a contribution button to open a pull request for quick fixes like typos, updates, or link fixes. + On the GitHub Docs site, you can click the make a contribution button to open a pull request for quick fixes like typos, updates, or link fixes. - + - For more complex contributions, you can open an issue using the most appropriate [issue template](https://github.com/github/docs/issues/new/choose) to describe the changes you'd like to see. + For more complex contributions, you can open an issue using the most appropriate [issue template](https://github.com/github/docs/issues/new/choose) to describe the changes you'd like to see. - If you're looking for a way to contribute, you can scan through our [existing issues](https://github.com/github/docs/issues) for something to work on. When ready, check out [Getting Started with Contributing](/CONTRIBUTING.md) for detailed instructions. + If you're looking for a way to contribute, you can scan through our [existing issues](https://github.com/github/docs/issues) for something to work on. When ready, check out [Getting Started with Contributing](/CONTRIBUTING.md) for detailed instructions. -### Join us in discussions -We use GitHub Discussions to talk about all sorts of topics related to documentation and this site. For example: if you'd like help troubleshooting a PR, have a great new idea, or want to share something amazing you've learned in our docs, join us in the [discussions](https://github.com/github/docs/discussions). -### And that's it! -If you're having trouble with your GitHub account, contact [Support](https://support.github.com/contact). -That's how you can easily become a member of the GitHub Documentation community. :sparkles: - ## READMEs + ### Join us in discussions + We use GitHub Discussions to talk about all sorts of topics related to documentation and this site. For example: if you'd like help troubleshooting a PR, have a great new idea, or want to share something amazing you've learned in our docs, join us in the [discussions](https://github.com/github/docs/discussions). + ### And that's it! + If you're having trouble with your GitHub account, contact [Support](https://support.github.com/contact). + That's how you can easily become a member of the GitHub Documentation community. :sparkles: + ## READMEs - 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: + 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: - - [content/README.md](content/README.md) - - [content/graphql/README.md](content/graphql/README.md) -- [content/rest/README.md](content/rest/README.md) -- [contributing/README.md](contributing/README.md) -- [data/README.md](data/README.md) -- [data/reusables/README.md](data/reusables/README.md) -- [data/variables/README.md](data/variables/README.md) -- [includes/liquid-tags/README.md](includes/liquid-tags/README.md) -- [includes/README.md](includes/README.md) -- [components/README.md](components/README.md) -- [lib/liquid-tags/README.md](lib/liquid-tags/README.md) -- [middleware/README.md](middleware/README.md) -- [script/README.md](script/README.md) -- [stylesheets/README.md](stylesheets/README.md) -- [tests/README.md](tests/README.md) -## License -The GitHub product documentation in the assets, content, and data folders are licensed under a [CC-BY license](LICENSE). + - [content/README.md](content/README.md) + - [content/graphql/README.md](content/graphql/README.md) + - [content/rest/README.md](content/rest/README.md) + - [contributing/README.md](contributing/README.md) + - [data/README.md](data/README.md) + - [data/reusables/README.md](data/reusables/README.md) + - [data/variables/README.md](data/variables/README.md) + - [includes/liquid-tags/README.md](includes/liquid-tags/README.md) + - [includes/README.md](includes/README.md) + - [components/README.md](components/README.md) + - [lib/liquid-tags/README.md](lib/liquid-tags/README.md) + - [middleware/README.md](middleware/README.md) + - [script/README.md](script/README.md) + - [stylesheets/README.md](stylesheets/README.md) + - [tests/README.md](tests/README.md) + ## License + The GitHub product documentation in the assets, content, and data folders are licensed under a [CC-BY license](LICENSE). - All other code in this repository is licensed under the [MIT license](LICENSE-CODE). + All other code in this repository is licensed under the [MIT license](LICENSE-CODE). - When using the GitHub logos, be sure to follow the [GitHub logo guidelines](https://github.com/logos). + When using the GitHub logos, be sure to follow the [GitHub logo guidelines](https://github.com/logos). - ## Thanks :purple_heart: + ## Thanks :purple_heart: -Thanks for all your contributions and efforts towards improving the GitHub documentation. We thank you being part of our :sparkles: community :sparkles: ! + Thanks for all your contributions and efforts towards improving the GitHub documentation. We thank you being part of our :sparkles: community :sparkles: ! From 0e10a8628ce7e32c0d33c2546c0f02829bf61d05 Mon Sep 17 00:00:00 2001 From: Simontrinh0911 Date: Mon, 29 Aug 2022 23:12:24 +0200 Subject: [PATCH 3/5] Update README.md --- README.md | 112 ++++++++++++++++++++++++++++++------------------------ 1 file changed, 62 insertions(+), 50 deletions(-) diff --git a/README.md b/README.md index 75c418a0207d..8330d7cf77ce 100644 --- a/README.md +++ b/README.md @@ -1,51 +1,63 @@ # GitHub Docs - This repository contains the documentation website code and Markdown source files for [docs.github.com](https://docs.github.com). - GitHub's Docs team works on pre-production content in a private repo that regularly syncs with this public repo. - Use the table of contents icon on the top left corner of this document to get to a specific section of this guide quickly. - ## Contributing - See [the contributing guide](CONTRIBUTING.md) for detailed instructions on how to get started with our project. - - We accept different [types of contributions](https://github.com/github/docs/blob/main/contributing/types-of-contributions.md), including some that don't require you to write a single line of code. - - On the GitHub Docs site, you can click the make a contribution button to open a pull request for quick fixes like typos, updates, or link fixes. - - - - For more complex contributions, you can open an issue using the most appropriate [issue template](https://github.com/github/docs/issues/new/choose) to describe the changes you'd like to see. - - If you're looking for a way to contribute, you can scan through our [existing issues](https://github.com/github/docs/issues) for something to work on. When ready, check out [Getting Started with Contributing](/CONTRIBUTING.md) for detailed instructions. - - ### Join us in discussions - We use GitHub Discussions to talk about all sorts of topics related to documentation and this site. For example: if you'd like help troubleshooting a PR, have a great new idea, or want to share something amazing you've learned in our docs, join us in the [discussions](https://github.com/github/docs/discussions). - ### And that's it! - If you're having trouble with your GitHub account, contact [Support](https://support.github.com/contact). - That's how you can easily become a member of the GitHub Documentation community. :sparkles: - ## READMEs - - 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: - - - [content/README.md](content/README.md) - - [content/graphql/README.md](content/graphql/README.md) - - [content/rest/README.md](content/rest/README.md) - - [contributing/README.md](contributing/README.md) - - [data/README.md](data/README.md) - - [data/reusables/README.md](data/reusables/README.md) - - [data/variables/README.md](data/variables/README.md) - - [includes/liquid-tags/README.md](includes/liquid-tags/README.md) - - [includes/README.md](includes/README.md) - - [components/README.md](components/README.md) - - [lib/liquid-tags/README.md](lib/liquid-tags/README.md) - - [middleware/README.md](middleware/README.md) - - [script/README.md](script/README.md) - - [stylesheets/README.md](stylesheets/README.md) - - [tests/README.md](tests/README.md) - ## License - The GitHub product documentation in the assets, content, and data folders are licensed under a [CC-BY license](LICENSE). - - All other code in this repository is licensed under the [MIT license](LICENSE-CODE). - - When using the GitHub logos, be sure to follow the [GitHub logo guidelines](https://github.com/logos). - - ## Thanks :purple_heart: - - Thanks for all your contributions and efforts towards improving the GitHub documentation. We thank you being part of our :sparkles: community :sparkles: ! + This repository contains the documentation website code and Markdown source files for [docs.github.com](https://docs.github.com). + GitHub's Docs team works on pre-production content in a private repo that regularly syncs with this public repo. + Use the table of contents icon on the top left corner of this document to get to a specific section of this guide quickly. + ## Contributing + See [the contributing guide](CONTRIBUTING.md) for detailed instructions on how to get started with our project. + + + This repository contains the documentation website code and Markdown source files for [docs.github.com](https://docs.github.com). We accept different [types of contributions](https://github.com/github/docs/blob/main/contributing/types-of-contributions.md), including some that don't require you to write a single line of code. + + + GitHub's Docs team works on pre-production content in a private repo that regularly syncs with this public repo. On the GitHub Docs site, you can click the make a contribution button to open a pull request for quick fixes like typos, updates, or link fixes. + + + Use the table of contents icon on the top left corner of this document to get to a specific section of this guide quickly. + + + ## Contributing For more complex contributions, you can open an issue using the most appropriate [issue template](https://github.com/github/docs/issues/new/choose) to describe the changes you'd like to see. + + + See [the contributing guide](CONTRIBUTING.md) for detailed instructions on how to get started with our project. If you're looking for a way to contribute, you can scan through our [existing issues](https://github.com/github/docs/issues) for something to work on. When ready, check out [Getting Started with Contributing](/CONTRIBUTING.md) for detailed instructions. + + + We accept different [types of contributions](https://github.com/github/docs/blob/main/contributing/types-of-contributions.md), including some that don't require you to write a single line of code. ### Join us in discussions + We use GitHub Discussions to talk about all sorts of topics related to documentation and this site. For example: if you'd like help troubleshooting a PR, have a great new idea, or want to share something amazing you've learned in our docs, join us in the [discussions](https://github.com/github/docs/discussions). + ### And that's it! + If you're having trouble with your GitHub account, contact [Support](https://support.github.com/contact). + That's how you can easily become a member of the GitHub Documentation community. :sparkles: + ## READMEs + + + On the GitHub Docs site, you can click 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. 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: + + + - [content/README.md](content/README.md) + - [content/graphql/README.md](content/graphql/README.md) + - [content/rest/README.md](content/rest/README.md) + - [contributing/README.md](contributing/README.md) + - [data/README.md](data/README.md) + - [data/reusables/README.md](data/reusables/README.md) + - [data/variables/README.md](data/variables/README.md) + - [includes/liquid-tags/README.md](includes/liquid-tags/README.md) + - [includes/README.md](includes/README.md) + - [components/README.md](components/README.md) + - [lib/liquid-tags/README.md](lib/liquid-tags/README.md) + - [middleware/README.md](middleware/README.md) + - [script/README.md](script/README.md) + - [stylesheets/README.md](stylesheets/README.md) + - [tests/README.md](tests/README.md) + ## License + The GitHub product documentation in the assets, content, and data folders are licensed under a [CC-BY license](LICENSE). + + + For more complex contributions, you can open an issue using the most appropriate [issue template](https://github.com/github/docs/issues/new/choose) to describe the changes you'd like to see. All other code in this repository is licensed under the [MIT license](LICENSE-CODE). + + + If you're looking for a way to contribute, you can scan through our [existing issues](https://github.com/github/docs/issues) for something to work on. When ready, check out [Getting Started with Contributing](/CONTRIBUTING.md) for detailed instructions. When using the GitHub logos, be sure to follow the [GitHub logo guidelines](https://github.com/logos). + + + ### Join us in discussions ## Thanks :purple_heart: + + + We use GitHub Discussions to talk about all sorts of topics related to documentation and this site. For example: if you'd like help troubleshooting a PR, have a great new idea, or want to share something amazing you've learned in our docs, join us in the [discussions](https://github.com/github/docs/discussions). Thanks for all your contributions and efforts towards improving the GitHub documentation. We thank you being part of our :sparkles: community :sparkles: ! From aec40fa322f18642c6838ff351b88bda2cc9a2a9 Mon Sep 17 00:00:00 2001 From: Simontrinh0911 Date: Mon, 29 Aug 2022 23:13:21 +0200 Subject: [PATCH 4/5] Update README.md --- README.md | 110 +++++++++++++++++++++++++++++++++--------------------- 1 file changed, 67 insertions(+), 43 deletions(-) diff --git a/README.md b/README.md index 8330d7cf77ce..b42cb09b42ba 100644 --- a/README.md +++ b/README.md @@ -1,63 +1,87 @@ # GitHub Docs - This repository contains the documentation website code and Markdown source files for [docs.github.com](https://docs.github.com). - GitHub's Docs team works on pre-production content in a private repo that regularly syncs with this public repo. - Use the table of contents icon on the top left corner of this document to get to a specific section of this guide quickly. - ## Contributing - See [the contributing guide](CONTRIBUTING.md) for detailed instructions on how to get started with our project. - - This repository contains the documentation website code and Markdown source files for [docs.github.com](https://docs.github.com). We accept different [types of contributions](https://github.com/github/docs/blob/main/contributing/types-of-contributions.md), including some that don't require you to write a single line of code. + This repository contains the documentation website code and Markdown source files for [docs.github.com](https://docs.github.com). + This repository contains the documentation website code and Markdown source files for [docs.github.com](https://docs.github.com). GitHub's Docs team works on pre-production content in a private repo that regularly syncs with this public repo. - - GitHub's Docs team works on pre-production content in a private repo that regularly syncs with this public repo. On the GitHub Docs site, you can click the make a contribution button to open a pull request for quick fixes like typos, updates, or link fixes. + Use the table of contents icon on the top left corner of this document to get to a specific section of this guide quickly. + GitHub's Docs team works on pre-production content in a private repo that regularly syncs with this public repo. ## Contributing + See [the contributing guide](CONTRIBUTING.md) for detailed instructions on how to get started with our project. + Use the table of contents icon on the top left corner of this document to get to a specific section of this guide quickly. - Use the table of contents icon on the top left corner of this document to get to a specific section of this guide quickly. - - ## Contributing For more complex contributions, you can open an issue using the most appropriate [issue template](https://github.com/github/docs/issues/new/choose) to describe the changes you'd like to see. + ## Contributing This repository contains the documentation website code and Markdown source files for [docs.github.com](https://docs.github.com). We accept different [types of contributions](https://github.com/github/docs/blob/main/contributing/types-of-contributions.md), including some that don't require you to write a single line of code. - See [the contributing guide](CONTRIBUTING.md) for detailed instructions on how to get started with our project. If you're looking for a way to contribute, you can scan through our [existing issues](https://github.com/github/docs/issues) for something to work on. When ready, check out [Getting Started with Contributing](/CONTRIBUTING.md) for detailed instructions. - + See [the contributing guide](CONTRIBUTING.md) for detailed instructions on how to get started with our project. + + GitHub's Docs team works on pre-production content in a private repo that regularly syncs with this public repo. On the GitHub Docs site, you can click the make a contribution button to open a pull request for quick fixes like typos, updates, or link fixes. + We accept different [types of contributions](https://github.com/github/docs/blob/main/contributing/types-of-contributions.md), including some that don't require you to write a single line of code. - We accept different [types of contributions](https://github.com/github/docs/blob/main/contributing/types-of-contributions.md), including some that don't require you to write a single line of code. ### Join us in discussions - We use GitHub Discussions to talk about all sorts of topics related to documentation and this site. For example: if you'd like help troubleshooting a PR, have a great new idea, or want to share something amazing you've learned in our docs, join us in the [discussions](https://github.com/github/docs/discussions). - ### And that's it! - If you're having trouble with your GitHub account, contact [Support](https://support.github.com/contact). - That's how you can easily become a member of the GitHub Documentation community. :sparkles: - ## READMEs - - On the GitHub Docs site, you can click 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. 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: + On the GitHub Docs site, you can click 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. Use the table of contents icon on the top left corner of this document to get to a specific section of this guide quickly. - - [content/README.md](content/README.md) - - [content/graphql/README.md](content/graphql/README.md) - - [content/rest/README.md](content/rest/README.md) - - [contributing/README.md](contributing/README.md) - - [data/README.md](data/README.md) - - [data/reusables/README.md](data/reusables/README.md) - - [data/variables/README.md](data/variables/README.md) - - [includes/liquid-tags/README.md](includes/liquid-tags/README.md) - - [includes/README.md](includes/README.md) - - [components/README.md](components/README.md) - - [lib/liquid-tags/README.md](lib/liquid-tags/README.md) - - [middleware/README.md](middleware/README.md) - - [script/README.md](script/README.md) - - [stylesheets/README.md](stylesheets/README.md) - - [tests/README.md](tests/README.md) - ## License - The GitHub product documentation in the assets, content, and data folders are licensed under a [CC-BY license](LICENSE). + + + ## Contributing For more complex contributions, you can open an issue using the most appropriate [issue template](https://github.com/github/docs/issues/new/choose) to describe the changes you'd like to see. + For more complex contributions, you can open an issue using the most appropriate [issue template](https://github.com/github/docs/issues/new/choose) to describe the changes you'd like to see. + + + If you're looking for a way to contribute, you can scan through our [existing issues](https://github.com/github/docs/issues) for something to work on. When ready, check out [Getting Started with Contributing](/CONTRIBUTING.md) for detailed instructions. See [the contributing guide](CONTRIBUTING.md) for detailed instructions on how to get started with our project. If you're looking for a way to contribute, you can scan through our [existing issues](https://github.com/github/docs/issues) for something to work on. When ready, check out [Getting Started with Contributing](/CONTRIBUTING.md) for detailed instructions. - For more complex contributions, you can open an issue using the most appropriate [issue template](https://github.com/github/docs/issues/new/choose) to describe the changes you'd like to see. All other code in this repository is licensed under the [MIT license](LICENSE-CODE). + ### Join us in discussions + + We accept different [types of contributions](https://github.com/github/docs/blob/main/contributing/types-of-contributions.md), including some that don't require you to write a single line of code. ### Join us in discussions + We use GitHub Discussions to talk about all sorts of topics related to documentation and this site. For example: if you'd like help troubleshooting a PR, have a great new idea, or want to share something amazing you've learned in our docs, join us in the [discussions](https://github.com/github/docs/discussions). We use GitHub Discussions to talk about all sorts of topics related to documentation and this site. For example: if you'd like help troubleshooting a PR, have a great new idea, or want to share something amazing you've learned in our docs, join us in the [discussions](https://github.com/github/docs/discussions). + + ### And that's it! + ### And that's it! If you're having trouble with your GitHub account, contact [Support](https://support.github.com/contact). + That's how you can easily become a member of the GitHub Documentation community. :sparkles: + If you're having trouble with your GitHub account, contact [Support](https://support.github.com/contact). ## READMEs + + + That's how you can easily become a member of the GitHub Documentation community. :sparkles: + + On the GitHub Docs site, you can click 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. 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: + ## READMEs - If you're looking for a way to contribute, you can scan through our [existing issues](https://github.com/github/docs/issues) for something to work on. When ready, check out [Getting Started with Contributing](/CONTRIBUTING.md) for detailed instructions. When using the GitHub logos, be sure to follow the [GitHub logo guidelines](https://github.com/logos). + + 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: - [content/README.md](content/README.md) + + - [content/graphql/README.md](content/graphql/README.md) + - [content/README.md](content/README.md) - [content/rest/README.md](content/rest/README.md) + - [content/graphql/README.md](content/graphql/README.md) - [contributing/README.md](contributing/README.md) + - [content/rest/README.md](content/rest/README.md) - [data/README.md](data/README.md) + - [contributing/README.md](contributing/README.md) - [data/reusables/README.md](data/reusables/README.md) + - [data/README.md](data/README.md) - [data/variables/README.md](data/variables/README.md) + - [data/reusables/README.md](data/reusables/README.md) - [includes/liquid-tags/README.md](includes/liquid-tags/README.md) + - [data/variables/README.md](data/variables/README.md) - [includes/README.md](includes/README.md) + - [components/README.md](components/README.md) - [components/README.md](components/README.md) + - [lib/liquid-tags/README.md](lib/liquid-tags/README.md) - [lib/liquid-tags/README.md](lib/liquid-tags/README.md) + - [middleware/README.md](middleware/README.md) - [middleware/README.md](middleware/README.md) + - [script/README.md](script/README.md) - [script/README.md](script/README.md) + - [stylesheets/README.md](stylesheets/README.md) - [stylesheets/README.md](stylesheets/README.md) + - [tests/README.md](tests/README.md) - [tests/README.md](tests/README.md) + + ## License + ## License The GitHub product documentation in the assets, content, and data folders are licensed under a [CC-BY license](LICENSE). - ### Join us in discussions ## Thanks :purple_heart: + The GitHub product documentation in the assets, content, and data folders are licensed under a [CC-BY license](LICENSE). + + For more complex contributions, you can open an issue using the most appropriate [issue template](https://github.com/github/docs/issues/new/choose) to describe the changes you'd like to see. All other code in this repository is licensed under the [MIT license](LICENSE-CODE). + All other code in this repository is licensed under the [MIT license](LICENSE-CODE). + + + When using the GitHub logos, be sure to follow the [GitHub logo guidelines](https://github.com/logos). If you're looking for a way to contribute, you can scan through our [existing issues](https://github.com/github/docs/issues) for something to work on. When ready, check out [Getting Started with Contributing](/CONTRIBUTING.md) for detailed instructions. When using the GitHub logos, be sure to follow the [GitHub logo guidelines](https://github.com/logos). - We use GitHub Discussions to talk about all sorts of topics related to documentation and this site. For example: if you'd like help troubleshooting a PR, have a great new idea, or want to share something amazing you've learned in our docs, join us in the [discussions](https://github.com/github/docs/discussions). Thanks for all your contributions and efforts towards improving the GitHub documentation. We thank you being part of our :sparkles: community :sparkles: ! + ## Thanks :purple_heart: + + ### Join us in discussions ## Thanks :purple_heart: + Thanks for all your contributions and efforts towards improving the GitHub documentation. We thank you for being part of our :sparkles: community :sparkles:! + + We use GitHub Discussions to talk about all sorts of topics related to documentation and this site. For example: if you'd like help troubleshooting a PR, have a great new idea, or want to share something amazing you've learned in our docs, join us in the [discussions](https://github.com/github/docs/discussions). Thanks for all your contributions and efforts towards improving the GitHub documentation. We thank you being part of our :sparkles: community :sparkles: ! From db31b7f99f759fe41869253d1b425ca0391a3a76 Mon Sep 17 00:00:00 2001 From: Simontrinh0911 Date: Mon, 29 Aug 2022 23:14:06 +0200 Subject: [PATCH 5/5] Update README.md --- README.md | 138 ++++++++++++++++++++++++++++++++---------------------- 1 file changed, 81 insertions(+), 57 deletions(-) diff --git a/README.md b/README.md index b42cb09b42ba..4a6554fc90b6 100644 --- a/README.md +++ b/README.md @@ -1,87 +1,111 @@ # GitHub Docs - This repository contains the documentation website code and Markdown source files for [docs.github.com](https://docs.github.com). - This repository contains the documentation website code and Markdown source files for [docs.github.com](https://docs.github.com). GitHub's Docs team works on pre-production content in a private repo that regularly syncs with this public repo. - - Use the table of contents icon on the top left corner of this document to get to a specific section of this guide quickly. - GitHub's Docs team works on pre-production content in a private repo that regularly syncs with this public repo. ## Contributing + + This repository contains the documentation website code and Markdown source files for [docs.github.com](https://docs.github.com). This repository contains the documentation website code and Markdown source files for [docs.github.com](https://docs.github.com). - See [the contributing guide](CONTRIBUTING.md) for detailed instructions on how to get started with our project. - Use the table of contents icon on the top left corner of this document to get to a specific section of this guide quickly. + This repository contains the documentation website code and Markdown source files for [docs.github.com](https://docs.github.com). GitHub's Docs team works on pre-production content in a private repo that regularly syncs with this public repo. + GitHub's Docs team works on pre-production content in a private repo that regularly syncs with this public repo. + Use the table of contents icon on the top left corner of this document to get to a specific section of this guide quickly. + Use the table of contents icon on the top left corner of this document to get to a specific section of this guide quickly. GitHub's Docs team works on pre-production content in a private repo that regularly syncs with this public repo. ## Contributing + - ## Contributing This repository contains the documentation website code and Markdown source files for [docs.github.com](https://docs.github.com). We accept different [types of contributions](https://github.com/github/docs/blob/main/contributing/types-of-contributions.md), including some that don't require you to write a single line of code. + ## Contributing See [the contributing guide](CONTRIBUTING.md) for detailed instructions on how to get started with our project. + Use the table of contents icon on the top left corner of this document to get to a specific section of this guide quickly. + See [the contributing guide](CONTRIBUTING.md) for detailed instructions on how to get started with our project. - See [the contributing guide](CONTRIBUTING.md) for detailed instructions on how to get started with our project. - GitHub's Docs team works on pre-production content in a private repo that regularly syncs with this public repo. On the GitHub Docs site, you can click the make a contribution button to open a pull request for quick fixes like typos, updates, or link fixes. - We accept different [types of contributions](https://github.com/github/docs/blob/main/contributing/types-of-contributions.md), including some that don't require you to write a single line of code. + We accept different [types of contributions](https://github.com/github/docs/blob/main/contributing/types-of-contributions.md), including some that don't require you to write a single line of code. ## Contributing This repository contains the documentation website code and Markdown source files for [docs.github.com](https://docs.github.com). We accept different [types of contributions](https://github.com/github/docs/blob/main/contributing/types-of-contributions.md), including some that don't require you to write a single line of code. + + + On the GitHub Docs site, you can click 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. + See [the contributing guide](CONTRIBUTING.md) for detailed instructions on how to get started with our project. + - On the GitHub Docs site, you can click 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. Use the table of contents icon on the top left corner of this document to get to a specific section of this guide quickly. + GitHub's Docs team works on pre-production content in a private repo that regularly syncs with this public repo. On the GitHub Docs site, you can click the make a contribution button to open a pull request for quick fixes like typos, updates, or link fixes. + For more complex contributions, you can open an issue using the most appropriate [issue template](https://github.com/github/docs/issues/new/choose) to describe the changes you'd like to see. We accept different [types of contributions](https://github.com/github/docs/blob/main/contributing/types-of-contributions.md), including some that don't require you to write a single line of code. - + If you're looking for a way to contribute, you can scan through our [existing issues](https://github.com/github/docs/issues) for something to work on. When ready, check out [Getting Started with Contributing](/CONTRIBUTING.md) for detailed instructions. - ## Contributing For more complex contributions, you can open an issue using the most appropriate [issue template](https://github.com/github/docs/issues/new/choose) to describe the changes you'd like to see. - For more complex contributions, you can open an issue using the most appropriate [issue template](https://github.com/github/docs/issues/new/choose) to describe the changes you'd like to see. + On the GitHub Docs site, you can click 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. Use the table of contents icon on the top left corner of this document to get to a specific section of this guide quickly. + ### Join us in discussions - If you're looking for a way to contribute, you can scan through our [existing issues](https://github.com/github/docs/issues) for something to work on. When ready, check out [Getting Started with Contributing](/CONTRIBUTING.md) for detailed instructions. See [the contributing guide](CONTRIBUTING.md) for detailed instructions on how to get started with our project. If you're looking for a way to contribute, you can scan through our [existing issues](https://github.com/github/docs/issues) for something to work on. When ready, check out [Getting Started with Contributing](/CONTRIBUTING.md) for detailed instructions. + We use GitHub Discussions to talk about all sorts of topics related to documentation and this site. For example: if you'd like help troubleshooting a PR, have a great new idea, or want to share something amazing you've learned in our docs, join us in the [discussions](https://github.com/github/docs/discussions). - ### Join us in discussions - - We accept different [types of contributions](https://github.com/github/docs/blob/main/contributing/types-of-contributions.md), including some that don't require you to write a single line of code. ### Join us in discussions - We use GitHub Discussions to talk about all sorts of topics related to documentation and this site. For example: if you'd like help troubleshooting a PR, have a great new idea, or want to share something amazing you've learned in our docs, join us in the [discussions](https://github.com/github/docs/discussions). We use GitHub Discussions to talk about all sorts of topics related to documentation and this site. For example: if you'd like help troubleshooting a PR, have a great new idea, or want to share something amazing you've learned in our docs, join us in the [discussions](https://github.com/github/docs/discussions). - - ### And that's it! - ### And that's it! If you're having trouble with your GitHub account, contact [Support](https://support.github.com/contact). + ### And that's it! ## Contributing For more complex contributions, you can open an issue using the most appropriate [issue template](https://github.com/github/docs/issues/new/choose) to describe the changes you'd like to see. - That's how you can easily become a member of the GitHub Documentation community. :sparkles: - If you're having trouble with your GitHub account, contact [Support](https://support.github.com/contact). ## READMEs + For more complex contributions, you can open an issue using the most appropriate [issue template](https://github.com/github/docs/issues/new/choose) to describe the changes you'd like to see. + If you're having trouble with your GitHub account, contact [Support](https://support.github.com/contact). + + + That's how you can easily become a member of the GitHub Documentation community. :sparkles: If you're looking for a way to contribute, you can scan through our [existing issues](https://github.com/github/docs/issues) for something to work on. When ready, check out [Getting Started with Contributing](/CONTRIBUTING.md) for detailed instructions. See [the contributing guide](CONTRIBUTING.md) for detailed instructions on how to get started with our project. If you're looking for a way to contribute, you can scan through our [existing issues](https://github.com/github/docs/issues) for something to work on. When ready, check out [Getting Started with Contributing](/CONTRIBUTING.md) for detailed instructions. - That's how you can easily become a member of the GitHub Documentation community. :sparkles: + ## READMEs + + ### Join us in discussions + 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: + + We accept different [types of contributions](https://github.com/github/docs/blob/main/contributing/types-of-contributions.md), including some that don't require you to write a single line of code. ### Join us in discussions + - [content/README.md](content/README.md) We use GitHub Discussions to talk about all sorts of topics related to documentation and this site. For example: if you'd like help troubleshooting a PR, have a great new idea, or want to share something amazing you've learned in our docs, join us in the [discussions](https://github.com/github/docs/discussions). We use GitHub Discussions to talk about all sorts of topics related to documentation and this site. For example: if you'd like help troubleshooting a PR, have a great new idea, or want to share something amazing you've learned in our docs, join us in the [discussions](https://github.com/github/docs/discussions). + - [content/graphql/README.md](content/graphql/README.md) + - [content/rest/README.md](content/rest/README.md) ### And that's it! + - [contributing/README.md](contributing/README.md) ### And that's it! If you're having trouble with your GitHub account, contact [Support](https://support.github.com/contact). + - [data/README.md](data/README.md) + - [data/reusables/README.md](data/reusables/README.md) That's how you can easily become a member of the GitHub Documentation community. :sparkles: + - [data/variables/README.md](data/variables/README.md) If you're having trouble with your GitHub account, contact [Support](https://support.github.com/contact). ## READMEs + - [components/README.md](components/README.md) + - [lib/liquid-tags/README.md](lib/liquid-tags/README.md) + - [middleware/README.md](middleware/README.md) That's how you can easily become a member of the GitHub Documentation community. :sparkles: + - [script/README.md](script/README.md) + - [stylesheets/README.md](stylesheets/README.md) On the GitHub Docs site, you can click 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. 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: + - [tests/README.md](tests/README.md) ## READMEs + - On the GitHub Docs site, you can click 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. 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: - ## READMEs + ## License + 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: - [content/README.md](content/README.md) + The GitHub product documentation in the assets, content, and data folders are licensed under a [CC-BY license](LICENSE). - 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: - [content/README.md](content/README.md) + - [content/graphql/README.md](content/graphql/README.md) + All other code in this repository is licensed under the [MIT license](LICENSE-CODE). - [content/README.md](content/README.md) - [content/rest/README.md](content/rest/README.md) - - [content/graphql/README.md](content/graphql/README.md) - - [content/README.md](content/README.md) - [content/rest/README.md](content/rest/README.md) - - [content/graphql/README.md](content/graphql/README.md) - [contributing/README.md](contributing/README.md) - - [content/rest/README.md](content/rest/README.md) - [data/README.md](data/README.md) - - [contributing/README.md](contributing/README.md) - [data/reusables/README.md](data/reusables/README.md) - - [data/README.md](data/README.md) - [data/variables/README.md](data/variables/README.md) - - [data/reusables/README.md](data/reusables/README.md) - [includes/liquid-tags/README.md](includes/liquid-tags/README.md) - - [data/variables/README.md](data/variables/README.md) - [includes/README.md](includes/README.md) - - [components/README.md](components/README.md) - [components/README.md](components/README.md) - - [lib/liquid-tags/README.md](lib/liquid-tags/README.md) - [lib/liquid-tags/README.md](lib/liquid-tags/README.md) - - [middleware/README.md](middleware/README.md) - [middleware/README.md](middleware/README.md) - - [script/README.md](script/README.md) - [script/README.md](script/README.md) - - [stylesheets/README.md](stylesheets/README.md) - [stylesheets/README.md](stylesheets/README.md) - - [tests/README.md](tests/README.md) - [tests/README.md](tests/README.md) + - [content/graphql/README.md](content/graphql/README.md) - [contributing/README.md](contributing/README.md) + When using the GitHub logos, be sure to follow the [GitHub logo guidelines](https://github.com/logos). - [content/rest/README.md](content/rest/README.md) - [data/README.md](data/README.md) - ## License - ## License The GitHub product documentation in the assets, content, and data folders are licensed under a [CC-BY license](LICENSE). + - [contributing/README.md](contributing/README.md) - [data/reusables/README.md](data/reusables/README.md) + ## Thanks :purple_heart: - [data/README.md](data/README.md) - [data/variables/README.md](data/variables/README.md) - - The GitHub product documentation in the assets, content, and data folders are licensed under a [CC-BY license](LICENSE). - - For more complex contributions, you can open an issue using the most appropriate [issue template](https://github.com/github/docs/issues/new/choose) to describe the changes you'd like to see. All other code in this repository is licensed under the [MIT license](LICENSE-CODE). - All other code in this repository is licensed under the [MIT license](LICENSE-CODE). - - - When using the GitHub logos, be sure to follow the [GitHub logo guidelines](https://github.com/logos). If you're looking for a way to contribute, you can scan through our [existing issues](https://github.com/github/docs/issues) for something to work on. When ready, check out [Getting Started with Contributing](/CONTRIBUTING.md) for detailed instructions. When using the GitHub logos, be sure to follow the [GitHub logo guidelines](https://github.com/logos). + - [data/reusables/README.md](data/reusables/README.md) - [includes/liquid-tags/README.md](includes/liquid-tags/README.md) + Thanks for all your contributions and efforts towards improving the GitHub documentation. We thank you for being part of our :sparkles: community :sparkles:! - [data/variables/README.md](data/variables/README.md) - [includes/README.md](includes/README.md) + - [components/README.md](components/README.md) - [components/README.md](components/README.md) + - [lib/liquid-tags/README.md](lib/liquid-tags/README.md) - [lib/liquid-tags/README.md](lib/liquid-tags/README.md) + - [middleware/README.md](middleware/README.md) - [middleware/README.md](middleware/README.md) + - [script/README.md](script/README.md) - [script/README.md](script/README.md) + - [stylesheets/README.md](stylesheets/README.md) - [stylesheets/README.md](stylesheets/README.md) + - [tests/README.md](tests/README.md) - [tests/README.md](tests/README.md) + + ## License + ## License The GitHub product documentation in the assets, content, and data folders are licensed under a [CC-BY license](LICENSE). - ## Thanks :purple_heart: + The GitHub product documentation in the assets, content, and data folders are licensed under a [CC-BY license](LICENSE). + + For more complex contributions, you can open an issue using the most appropriate [issue template](https://github.com/github/docs/issues/new/choose) to describe the changes you'd like to see. All other code in this repository is licensed under the [MIT license](LICENSE-CODE). + All other code in this repository is licensed under the [MIT license](LICENSE-CODE). + - ### Join us in discussions ## Thanks :purple_heart: - Thanks for all your contributions and efforts towards improving the GitHub documentation. We thank you for being part of our :sparkles: community :sparkles:! + When using the GitHub logos, be sure to follow the [GitHub logo guidelines](https://github.com/logos). If you're looking for a way to contribute, you can scan through our [existing issues](https://github.com/github/docs/issues) for something to work on. When ready, check out [Getting Started with Contributing](/CONTRIBUTING.md) for detailed instructions. When using the GitHub logos, be sure to follow the [GitHub logo guidelines](https://github.com/logos). + - We use GitHub Discussions to talk about all sorts of topics related to documentation and this site. For example: if you'd like help troubleshooting a PR, have a great new idea, or want to share something amazing you've learned in our docs, join us in the [discussions](https://github.com/github/docs/discussions). Thanks for all your contributions and efforts towards improving the GitHub documentation. We thank you being part of our :sparkles: community :sparkles: ! + ## Thanks :purple_heart: + + ### Join us in discussions ## Thanks :purple_heart: + Thanks for all your contributions and efforts towards improving the GitHub documentation. We thank you for being part of our :sparkles: community :sparkles:! + + We use GitHub Discussions to talk about all sorts of topics related to documentation and this site. For example: if you'd like help troubleshooting a PR, have a great new idea, or want to share something amazing you've learned in our docs, join us in the [discussions](https://github.com/github/docs/discussions). Thanks for all your contributions and efforts towards improving the GitHub documentation. We thank you being part of our :sparkles: community :sparkles: !