The open-source repo for docs.github.com

docs hacktoberfest works-with-codespaces

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

Octomerger Bot 8af590f03c Merge pull request #21769 from github/repo-sync repo sync		2021-09-27 18:09:30 -04: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	Announce if Heroku appears to be down (#21762 )	2021-09-27 20:17:05 +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	Add footnote section (#21648 )	2021-09-24 16:45:58 +00:00
components	remove currentLanguage from mainContext, use router.locale instead (#21716 )	2021-09-27 14:40:43 +00:00
content	Add doc for dealing with special characters in ref names (#9577 )	2021-09-27 21:46:12 +00:00
contributing	self-review.md fix link to localization checklist	2021-09-23 16:05:08 -07:00
data	Reorder sections to make it more clear to the reader that requesting a CVE number is optional (#10210 )	2021-09-27 01:14:45 +00:00
docs	Add Observability docs to service catalog (#16878 )	2020-12-12 00:04:54 +00:00
includes	revert alignment back to pre-prettified format (#21735 )	2021-09-24 21:32:01 +00:00
lib	Update OpenAPI Descriptions (#21757 )	2021-09-27 18:30:36 +00:00
middleware	Handle Liquid conditionals in track paths (#21755 )	2021-09-27 18:11:22 +00:00
pages	Restructure Actions guides (#21577 )	2021-09-22 16:49:41 +10:00
public/playground	Two-pane Experiment (#21092 )	2021-08-26 14:19:40 -04:00
script	Do not pass `null` config vars to Heroku on AppSetup (#21766 )	2021-09-27 15:47:04 -05:00
stylesheets	Add btn-primary-matte, ScrollButton, TruncateLines to storybook (#21611 )	2021-09-20 23:21:29 +00:00
tests	fix a few hardcoded tests temporarily (#21740 )	2021-09-27 20:56:42 +00:00
translations	Removing Codespaces translations for all languages (#21391 )	2021-09-09 17:25:48 -07: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	Upgrade pipeline with env `COMMONMARK=1 npm start` to see new, otherwise parse current (#20508 )	2021-07-29 14:24:26 +00:00
.gitattributes	LFS the Lunr Indexes (#20521 )	2021-07-27 22:06:31 +00:00
.gitignore	Remove storybook (#21037 )	2021-08-23 12:07:54 -07: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	CONTRIBUTING.md Fix syntax for atom docs link	2021-09-23 15:35:09 -07:00
Dockerfile	Docker image deploy to Heroku (#21248 )	2021-09-03 16:34:48 +00:00
Dockerfile.openapi_decorator	Add an openapi-check ci check and dockerize it (#18652 )	2021-04-09 11:02:53 -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	2021-09-22 07:46:00 -05:00
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	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	Refactor repo ref tests (#21631 )	2021-09-21 21:20:15 +00:00
package.json	Refactor repo ref tests (#21631 )	2021-09-21 21:20:15 +00:00
server.mjs	Remove `import x` statements (#20594 )	2021-07-29 20:28:30 +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 the this document to get to a specific section of this guide quickly.

Contributing

See the contributing guide for detailed instructions of 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 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 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 a 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 ✨ !