The open-source repo for docs.github.com
Перейти к файлу
Kevin Heis 79fa21e74d
Update build-docker-image.yml (#22666)
2021-11-08 18:08:37 +00:00
.devcontainer updating devcontainer to use dockerfile to install correct version of node and adds some other helpful extensions for working in docs (#20059) 2021-06-23 23:23:55 +00:00
.github Update build-docker-image.yml (#22666) 2021-11-08 18:08:37 +00:00
.husky Allow git operations when LFS isn't functioning (#20569) 2021-07-28 21:35:43 +00:00
.vscode Add VS Code debugger config (#16819) 2020-12-10 18:37:06 +00:00
assets/images Merge branch 'main' into patch-2 2021-11-03 13:01:21 -05:00
components Updating breadcrumbs (#22626) 2021-11-08 17:53:19 +00:00
content Merge branch 'main' into ivyharriet-ghas-billing 2021-11-08 16:55:41 +00:00
contributing Add format for linking to a learning path (#22575) 2021-11-04 13:15:34 +00:00
data Added new context properties and environment variables for refs (#22188) 2021-11-08 00:47:58 +00:00
docs Add Observability docs to service catalog (#16878) 2020-12-12 00:04:54 +00:00
includes Primer 18 b (#22462) 2021-10-28 19:17:23 +00:00
lib update search indexes 2021-11-08 17:59:11 +00:00
middleware fallback to English page when translation unavailable (#22638) 2021-11-05 09:43:47 -07:00
pages Article Layout Improvements (#22424) 2021-10-29 19:57:07 +00:00
script remove old unused scripts (#22650) 2021-11-08 17:43:59 +00:00
stylesheets Primer 18 b (#22462) 2021-10-28 19:17:23 +00:00
tests Updating breadcrumbs (#22626) 2021-11-08 17:53:19 +00:00
translations remove stale translations files (#22647) 2021-11-05 20:27:43 +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 Add test and script to ensure 1:1 parity of liquid tags between source and translation (#22472) 2021-11-04 10:59:17 -03:00
.gitattributes LFS the Lunr Indexes (#20521) 2021-07-27 22:06:31 +00:00
.gitignore Memoize loadRedirects() with disk (#22161) 2021-10-22 11:25:32 -04: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 revert alignment back to pre-prettified format (#21735) 2021-09-24 21:32:01 +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 Docker image deploy to Heroku (#21248) 2021-09-03 16:34:48 +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 Merge branch 'main' into main 2021-11-04 09:29:54 -05: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 Automatic update to next-env.d.ts file (#20917) 2021-08-17 17:22:34 +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 Crowdin broken liquid test (#22559) 2021-11-04 14:27:22 -07:00
package.json Crowdin broken liquid test (#22559) 2021-11-04 14:27:22 -07:00
server.mjs in development, block server start on warnServer (#22266) 2021-10-20 19:51:28 +00:00
tsconfig.json Two-pane Experiment (#21092) 2021-08-26 14:19:40 -04: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 PR(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. By this way you can also be a part of Open source contributor's community without even writing a single line of code.

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: YOu can go through among them for specified details regarding the topics listed below.

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 you are 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 !