The open-source repo for docs.github.com
Перейти к файлу
Sarah Schneider cd2a217a77 do not error if frontmatter includes next GHES release or hardcoded next 2021-03-17 10:29:16 -04:00
.github decorate script fix (#18201) 2021-03-15 18:40:00 -07:00
.vscode Add VS Code debugger config (#16819) 2020-12-10 18:37:06 +00:00
assets Clarify the availability of GHAS licenses for dotcom (#18246) 2021-03-17 11:49:32 +00:00
content Clarify the availability of GHAS licenses for dotcom (#18246) 2021-03-17 11:49:32 +00:00
contributing Add issue template to guide partner documentation contributions (#17998) 2021-03-12 11:05:29 -08:00
data Clarify the availability of GHAS licenses for dotcom (#18246) 2021-03-17 11:49:32 +00:00
docs Add Observability docs to service catalog (#16878) 2020-12-12 00:04:54 +00:00
includes [SEO] Correct footer links (#18136) 2021-03-15 09:57:26 -07:00
javascripts Update scroll-up.js 2021-02-23 08:55:01 -08:00
layouts Getting started category landing page (#17841) 2021-03-09 10:04:45 -06:00
lib do not error if frontmatter includes next GHES release or hardcoded next 2021-03-17 10:29:16 -04:00
middleware Prevent REALLY garbage request URLs (#18216) 2021-03-12 02:58:47 +00:00
react Update README.md 2021-02-04 13:12:00 -05:00
script check for openapi type property (#18257) 2021-03-16 08:59:14 -07:00
stylesheets Apply margin style to .contributor-callout p element 2021-03-11 12:27:40 -06:00
tests Revert "Group user docs on code security into a new "product" (#18196)" (#18277) 2021-03-17 08:07:11 +00:00
translations Revert "update signup info" 2021-03-05 16:29:24 -05:00
.devcontainer.json Remove `npm start` from Codespaces postCreateCommand (#18193) 2021-03-09 13:07:38 -06:00
.editorconfig chore: Add EditorConfig for IDE whitespace 2020-11-03 10:59:19 -05:00
.env.example Mostly reverting github/docs-internal#15313 2020-11-09 13:07:04 -06:00
.eslintignore chore: Convert Standard to eslint-config-standard (#1328) 2020-11-17 16:18:18 -05:00
.eslintrc.js chore: Convert Standard to eslint-config-standard (#1328) 2020-11-17 16:18:18 -05:00
.gitattributes Hello git history spelunker! 2020-09-27 14:10:11 +02:00
.gitignore Move site search to use an endpoint (#17359) 2021-01-20 15:37:42 +00:00
.node-version Upgrade to Node.js 14 (#15822) 2020-10-05 17:02:55 -07:00
.npmrc Hello git history spelunker! 2020-09-27 14:10:11 +02:00
.pa11yci Hello git history spelunker! 2020-09-27 14:10:11 +02:00
.prettierignore chore: Add Prettier for Yaml formatting 2020-11-16 16:12:49 -05:00
.prettierrc.json chore: Add Prettier for Yaml formatting 2020-11-16 16:12:49 -05: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 mention in contributing (#17045) 2020-12-17 18:10:24 +00:00
Dockerfile Block a few more things in AIRGAP (#17657) 2021-02-09 23:07:23 +00:00
Gemfile Hello git history spelunker! 2020-09-27 14:10:11 +02:00
Gemfile.lock reenable graphql updater (#16994) 2020-12-16 19:45:37 +00: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 Add release script to soft-purge all rendered pages from the Redis cache (#17164) 2021-01-07 13:50:24 -06:00
README.md Update README.md 2021-01-02 20:39:54 +05:30
app.json Remove DataDog from Staging (#17036) 2020-12-17 10:42:46 -05:00
crowdin.yml move deprecated site policy content to new directory (#17270) 2021-01-14 11:41:38 -08:00
feature-flags.json Remove versions feature flag code (#15793) 2020-09-29 13:36:07 -04:00
jest-puppeteer.config.js Hello git history spelunker! 2020-09-27 14:10:11 +02:00
jest.config.js Test workflow and jest configuration cleaning (#17759) 2021-02-09 10:52:28 -06:00
nodemon.json Hello git history spelunker! 2020-09-27 14:10:11 +02:00
ownership.yaml Update service catalog (#17762) 2021-02-09 19:05:35 +00:00
package-lock.json add script to read topics spreadsheet (#18175) 2021-03-11 17:20:27 -08:00
package.json add script to read topics spreadsheet (#18175) 2021-03-11 17:20:27 -08:00
server.js Add dotenv config to server.js (#18227) 2021-03-11 15:26:40 -05:00
webpack.config.js Move site search to use an endpoint (#17359) 2021-01-20 15:37:42 +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.

In this article:

Contributing

Start contributing right now:

We accept a lot of different contributions, including some that don't require you to write a single line of code.

Click make a contribution from docs

As you're using GitHub Docs, you may find something in an article that you'd like to add to, update, or change. Click on make a contribution to navigate directly to that article in the codebase, so that you can begin making your contribution.

Open an issue

If you've found a problem, you can open an issue using a template.

Solve an issue

If you have a solution to one of the open issues, you will need to fork the repository and submit a pull request using the template that is visible automatically in the pull request body. For more details about this process, please check out Getting Started with Contributing.

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 discussions.

And that's it!

That's how you can get started easily as a member of the GitHub Documentation community.

If you want to know more, or you're making a more complex contribution, check out Getting Started with Contributing.

There are a few more things to know when you're getting started with this repo:

  1. If you're having trouble with your GitHub account, contact Support.
  2. We do not accept pull requests for translated content - see CONTRIBUTING.md for more information.

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 a MIT license.

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