The open-source repo for docs.github.com
Перейти к файлу
github-openapi-bot f404f77036
Update OpenAPI Descriptions (#19952)
* Update OpenAPI Descriptions

* Add decorated OpenAPI schema files

Co-authored-by: github-openapi-bot <github-openapi-bot@users.noreply.github.com>
2021-06-16 11:04:46 +00:00
.github Update a few enterprise release steps (#19072) 2021-06-15 15:07:15 -07:00
.husky fix: update husky usage 2021-05-20 13:36:46 -07:00
.vscode Add VS Code debugger config (#16819) 2020-12-10 18:37:06 +00:00
assets Document the settings context switcher (#19836) 2021-06-14 09:38:45 +01:00
components fix: sometimes there are no childPages, such as /es/github-ae@latest/admin (#19944) 2021-06-15 22:19:25 +00:00
content Mention sponsorships for bill. mgrs (#19874) 2021-06-16 10:19:58 +00:00
contributing Update contrib mentions of headings after H3->H2 content migration (#19884) 2021-06-15 00:14:07 +00:00
data Moved remaining descriptions into reusables 2021-06-16 11:19:16 +10:00
docs Add Observability docs to service catalog (#16878) 2020-12-12 00:04:54 +00:00
includes Fix REST decorator for false default params (#19883) 2021-06-15 01:01:10 +00:00
javascripts fix ts bug (#19945) 2021-06-15 22:44:02 +00:00
layouts Landing pages only shows "view all" and "expore all" buttons if a guides page exists (#19914) 2021-06-14 23:59:28 +00:00
lib Update OpenAPI Descriptions (#19952) 2021-06-16 11:04:46 +00:00
middleware Enable more react pages (#19935) 2021-06-15 13:31:17 -07:00
pages Cleanup featuredLinks usage, fix insights page, better ArticleList (#19872) 2021-06-15 18:22:43 +00:00
script Update a few enterprise release steps (#19072) 2021-06-15 15:07:15 -07:00
stylesheets fix header styling, add missing sectionLinks (#19915) 2021-06-15 16:35:19 +00:00
tests Enable more react pages (#19935) 2021-06-15 13:31:17 -07:00
translations Translation batch 1623365515 (#19847) 2021-06-10 20:19:47 -07:00
.babelrc prettier .babelrc 2021-05-07 09:04:01 -07: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 SubLanding page filter (#19918) 2021-06-15 18:16:24 +00:00
.gitattributes Hello git history spelunker! 2020-09-27 14:10:11 +02:00
.gitignore feat: add nextjs middleware handling (#19139) 2021-05-05 15:23:46 +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 chore: Add Prettier for Yaml formatting 2020-11-16 16:12:49 -05:00
.prettierrc.json feat: add nextjs middleware handling (#19139) 2021-05-05 15:23:46 +00: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 feat: upgrade to node v16, package-lock.json v2, remove aws-sdk 2021-05-20 13:32:19 -07:00
Dockerfile Heroku dev deps (#19431) 2021-05-24 15:40:50 -07:00
Dockerfile.openapi_decorator Add an openapi-check ci check and dockerize it (#18652) 2021-04-09 11:02:53 -07: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 Heroku release command bash wrapper (#18743) 2021-04-13 21:12:20 +00:00
README.md Update README.md 2021-01-02 20:39:54 +05:30
app.json Heroku dev deps (#19431) 2021-05-24 15:40:50 -07:00
crowdin.yml move deprecated site policy content to new directory (#17270) 2021-01-14 11:41:38 -08: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 Default sponsors+discussions pages to nextjs rendering (#19667) 2021-06-03 11:17:15 -07:00
jest-puppeteer.config.js Hello git history spelunker! 2020-09-27 14:10:11 +02:00
jest.config.js Improvements in tools to help merge crowdin PRs (#18409) 2021-03-26 19:21:45 +00:00
next-env.d.ts feat: add nextjs middleware handling (#19139) 2021-05-05 15:23:46 +00:00
next.config.js Heroku dev deps (#19431) 2021-05-24 15:40:50 -07:00
nodemon.json Hello git history spelunker! 2020-09-27 14:10:11 +02:00
ownership.yaml Update ownership.yaml (#18762) 2021-04-14 10:49:54 -04:00
package-lock.json Enable more react pages (#19935) 2021-06-15 13:31:17 -07:00
package.json Update a few enterprise release steps (#19072) 2021-06-15 15:07:15 -07:00
server.js Do not use clustering in non-production environments (#18438) 2021-03-26 14:10:50 -05:00
tsconfig.json Update current JavaScripts to use Typescript (#19824) 2021-06-14 18:07:39 +00:00
webpack.config.js Update current JavaScripts to use Typescript (#19824) 2021-06-14 18:07:39 +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.