github/docs: The open-source repo for docs.github.com - docs

The open-source repo for docs.github.com

docs hacktoberfest works-with-codespaces

Перейти к файлу

Ethan Palm 1e359a0324 Add supported OS		2021-05-27 11:37:11 -04:00
.github	fix: remove unused from allowed-actions	2021-05-20 14:16:16 -07:00
.husky	fix: update husky usage	2021-05-20 13:36:46 -07:00
.vscode	…
assets	Desktop v2.8 docs update (#19310 )	2021-05-20 15:42:52 +00:00
components	remove and rename old site tree components (#19478 )	2021-05-20 18:58:54 +00:00
content	Add supported OS	2021-05-27 11:37:11 -04:00
contributing	Update content-model.md	2021-05-20 15:27:17 -05:00
data	Code scanning: replace deprecated `--github-auth` flag with new `--github-auth-stdin` flag (#19466 )	2021-05-24 09:17:08 +01:00
docs	…
includes	remove feature flagged code	2021-05-20 10:01:33 -04:00
javascripts	…
layouts	remove feature flagged code	2021-05-20 10:01:33 -04:00
lib	Update OpenAPI Descriptions (#19482 )	2021-05-21 07:18:38 +00:00
middleware	Merge branch 'main' into react-head-2	2021-05-20 11:06:59 -07:00
pages	Convert to new site tree (#19450 )	2021-05-20 11:35:02 -07:00
react	…
script	…
stylesheets	…
tests	Increase developer redirect test time (#19499 )	2021-05-21 20:13:32 +00:00
translations	…
.babelrc	…
.devcontainer.json	…
.editorconfig	…
.env.example	…
.eslintignore	…
.eslintrc.js	…
.gitattributes	…
.gitignore	…
.node-version	feat: upgrade to node v16, package-lock.json v2, remove aws-sdk	2021-05-20 13:32:19 -07:00
.npmrc	…
.pa11yci	…
.prettierignore	…
.prettierrc.json	…
CODE_OF_CONDUCT.md	…
CONTRIBUTING.md	feat: upgrade to node v16, package-lock.json v2, remove aws-sdk	2021-05-20 13:32:19 -07:00
Dockerfile	…
Dockerfile.openapi_decorator	…
Gemfile	…
Gemfile.lock	…
LICENSE	…
LICENSE-CODE	…
Procfile	…
README.md	…
app.json	…
crowdin.yml	…
docker-compose.yaml	…
feature-flags.json	remove feature flagged code	2021-05-20 10:01:33 -04:00
jest-puppeteer.config.js	…
jest.config.js	…
next-env.d.ts	…
next.config.js	…
nodemon.json	…
ownership.yaml	…
package-lock.json	feat: upgrade to node v16, package-lock.json v2, remove aws-sdk	2021-05-20 13:32:19 -07:00
package.json	fix: update husky usage	2021-05-20 13:36:46 -07:00
server.js	…
tsconfig.json	…
webpack.config.js	…

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
READMEs
License

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:

If you're having trouble with your GitHub account, contact Support.
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.