The open-source repo for docs.github.com
Перейти к файлу
hubwriter b570ff5629
Delete .devcontainer/test-custom-devcontainer directory
2022-04-06 09:09:20 +01:00
.devcontainer Delete .devcontainer/test-custom-devcontainer directory 2022-04-06 09:09:20 +01:00
.github Update optimize-images.yml 2022-04-05 08:31:20 -07:00
.husky Allow git operations when LFS isn't functioning (#20569) 2021-07-28 21:35:43 +00:00
.vscode Fix the workspace settings.json 2022-01-12 14:46:27 +00:00
assets/images Restructure and update enterprise-level audit log articles (#25526) 2022-04-06 13:33:14 +10:00
components use functional variables 2022-04-05 18:43:11 -04:00
content Restructure and update enterprise-level audit log articles (#25526) 2022-04-06 13:33:14 +10:00
contributing Github -> GitHub in our docs (fix spelling) (#26611) 2022-04-02 08:29:57 +00:00
data Restructure and update enterprise-level audit log articles (#25526) 2022-04-06 13:33:14 +10:00
docs Add Observability docs to service catalog (#16878) 2020-12-12 00:04:54 +00:00
includes remove rest include file (#25802) 2022-03-03 21:17:35 +00:00
lib update search indexes 2022-04-06 02:40:34 +00:00
middleware remove rate limiter and slow-down middleware (#26709) 2022-04-05 19:38:25 +00:00
pages Fix flash of incorrect theme for @primer/components (#24123) 2022-03-21 22:10:06 +00:00
script make PR about deletable orphan assets (#26484) 2022-03-30 11:56:18 -04:00
stylesheets Move mini tocs rest + collapsible (#26069) 2022-03-14 10:50:53 -07:00
tests don't test external early-access in unit tests (#26612) 2022-04-04 21:00:14 +00:00
translations New translation batch for ja (#26718) 2022-04-05 23:45:15 +00:00
.babelrc fix: filter hidden pages from the currentProductTree (SidebarProduct) (#20404) 2021-07-20 12:32:35 -04:00
.dockerignore Public Repo Azure Preview Environments (#25206) 2022-02-10 14:14:40 -06:00
.editorconfig chore: Add EditorConfig for IDE whitespace 2020-11-03 10:59:19 -05:00
.env.example Removing algolia (#20633) 2021-08-05 13:10:51 -04:00
.eslintrc.js eslint check the .github/actions-scripts/* files too (#23698) 2021-12-15 17:35:34 +00:00
.gitattributes LFS the Lunr Indexes (#20521) 2021-07-27 22:06:31 +00:00
.gitignore .redirects-cache_en_ja.json should not be checked in (#25537) 2022-02-22 18:22:59 +00:00
.node-version feat: upgrade to node v16, package-lock.json v2, remove aws-sdk 2021-05-20 13:32:19 -07:00
.npmrc Hello git history spelunker! 2020-09-27 14:10:11 +02:00
.pa11yci Changed title, links, updated intro and first section (#25875) 2022-03-12 01:47:15 +00:00
.prettierignore run prettier on all code in CI (#23482) 2021-12-08 16:11:52 +00:00
.prettierrc.json Pretty format (#20352) 2021-07-14 14:35:01 -07:00
CODE_OF_CONDUCT.md Add restriction on private contact of community members without permission (#16570) 2020-11-23 11:27:30 -07:00
CONTRIBUTING.md Update CONTRIBUTING.md 2022-04-01 10:39:26 +01:00
Dockerfile automatically start server for jest (#26206) 2022-03-18 21:46:07 +00:00
Dockerfile.openapi_decorator add `data` directory (#22529) 2021-11-02 07:35:03 -07:00
LICENSE Reorg LICENSE files to be more discoverable (#204) 2020-10-07 15:11:49 -07:00
LICENSE-CODE Edit as per review 2022-03-21 21:10:03 +05:30
README.md Test prebuild regeneration 2022-02-09 09:37:04 +00:00
azure-preview-env-template.json Remove Caddy from preview envs (#26336) 2022-03-22 10:47:53 -04:00
crowdin.yml cope with possible translation drift (#24842) 2022-02-04 14:31:56 +00:00
docker-compose.prod.tmpl.yaml remove rate limiter and slow-down middleware (#26709) 2022-04-05 19:38:25 +00:00
docker-compose.yaml Accept glob patterns for source files in openapi-check script (#18965) 2021-04-26 21:56:12 +00:00
feature-flags.json Remove FEATURE_NEXTJS Flag Part 1 (#20176) 2021-07-16 14:54:25 -07:00
jest-puppeteer.config.js Pretty format (#20352) 2021-07-14 14:35:01 -07:00
jest.config.js automatically start server for jest (#26206) 2022-03-18 21:46:07 +00:00
jest.setup.js Fail on console.error in tests with failOnConsole (#25600) 2022-02-25 10:49:27 -06:00
next-env.d.ts Revert back to using Next.js v11 (#24199) 2022-01-11 20:37:24 +00:00
next.config.js remove 'de' as a possible NextJS redirect language (#26315) 2022-03-18 19:19:36 +00:00
nodemon.json Create a storybook with callout component (#20902) 2021-08-17 20:28:59 +00:00
ownership.yaml Update ownership.yaml (#25551) 2022-02-23 16:23:00 -08:00
package-lock.json remove rate limiter and slow-down middleware (#26709) 2022-04-05 19:38:25 +00:00
package.json remove rate limiter and slow-down middleware (#26709) 2022-04-05 19:38:25 +00:00
server.mjs automatically start server for jest (#26206) 2022-03-18 21:46:07 +00:00
start-server.mjs automatically start server for jest (#26206) 2022-03-18 21:46:07 +00:00
tsconfig.json Refactor display-platform-specific-content (#22665) 2021-11-12 14:40:35 +00:00

README.md

GitHub Docs

This repository contains the documentation website code and Markdown source files for 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 for detailed instructions on how to get started with our project.

We accept different types of contributions, 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 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 for something to work on. When ready, check out Getting Started with Contributing 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.

And that's it!

If you're having trouble with your GitHub account, contact Support.

That's how you can easily become a member of the GitHub Documentation community.

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:

License

The GitHub product documentation in the assets, content, and data folders are licensed under a CC-BY license.

All other code in this repository is licensed under the MIT license.

When using the GitHub logos, be sure to follow the GitHub logo guidelines.

Thanks 💜

Thanks for all your contributions and efforts towards improving the GitHub documentation. We thank you being part of our community !