The open-source repo for docs.github.com
Перейти к файлу
Jules Parker 7f6e24474d fixing tests 2022-01-13 11:59:43 +01:00
.devcontainer Update devcontainer.json 2021-12-21 12:04:37 +00:00
.github fix: retry translation batch PR creation if we hit a 502 (#23633) 2022-01-11 23:06:18 +00: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 Updating Unwatch a Repository to include Multiple Repos - Take 2 (#24262) 2022-01-12 15:32:39 -08:00
components underline links on toc pages (#24217) 2022-01-11 20:48:35 +00:00
content Merge branch 'main' into jules-4800 2022-01-13 09:58:28 +01:00
contributing Update README.md (#24239) 2022-01-12 21:08:11 +00:00
data Updating Unwatch a Repository to include Multiple Repos - Take 2 (#24262) 2022-01-12 15:32:39 -08:00
docs Add Observability docs to service catalog (#16878) 2020-12-12 00:04:54 +00:00
includes remove tool-switcher (#24242) 2022-01-12 16:32:30 +00:00
lib update search indexes 2022-01-13 02:34:46 +00:00
middleware fix local dev with Safari (#24205) 2022-01-11 17:41:20 +00:00
pages remove storybook (#24122) 2022-01-06 12:11:58 -08:00
script Fix render translation test (#24235) 2022-01-12 13:26:58 +00:00
stylesheets Add label for search input (#24130) 2022-01-06 22:35:56 +00:00
tests fixing tests 2022-01-13 11:59:43 +01:00
translations New translation batch for ja (#24260) 2022-01-12 20:18:20 +00:00
.babelrc fix: filter hidden pages from the currentProductTree (SidebarProduct) (#20404) 2021-07-20 12:32:35 -04: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 Ignore the tsconfig.tsbuildinfo file (#23359) 2021-12-06 19:38:14 +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 Make orgs and teams content a top-level doc set (#18593) 2021-04-08 09:50:13 -05: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 (#22398) 2021-10-25 17:43:56 +00:00
Dockerfile Revert back to using Next.js v11 (#24199) 2022-01-11 20:37:24 +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 Reorg LICENSE files to be more discoverable (#204) 2020-10-07 15:11:49 -07:00
Procfile Remove all code related to Redis page caching (#20457) 2021-07-21 20:44:00 +00:00
README.md Update README.md (#24239) 2022-01-12 21:08:11 +00:00
app.json Heroku dev deps (#19431) 2021-05-24 15:40:50 -07:00
crowdin.yml fix: exclude target languages for source files (DE, KO, RU) (#22651) 2021-11-05 21:04:20 +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 updating package with the fix (#20922) 2021-08-17 16:56:55 +00:00
next-env.d.ts Revert back to using Next.js v11 (#24199) 2022-01-11 20:37:24 +00:00
next.config.js comment -> delete 2021-08-05 20:16:39 -05:00
nodemon.json Create a storybook with callout component (#20902) 2021-08-17 20:28:59 +00:00
ownership.yaml ownership.yaml: Remove deprecated `mention` field (#20645) 2021-08-04 15:13:35 +00:00
package-lock.json Lock Node version to `16.x` for Heroku (#24245) 2022-01-12 14:37:44 +00:00
package.json Lock Node version to `16.x` for Heroku (#24245) 2022-01-12 14:37:44 +00:00
server.mjs always warm the sever before listening (#23750) 2021-12-15 20:54:17 +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 !