b2c8af9d31
* Explicitly ensure the early access parent directories are created when cloning * Use explicit --file flag with tar * Remove security hole for Staging deployment by concatenating archives * Fail the staging builds if *.js, .npmrc, or Procfile is changed in the open source repo * docker build: extract user-code in separate directory * Checkout PR base branch and install dependencies * Remove one-off package installs * Remove selective file checkout * Don't persist git cloning credentials It usually makes the clone of early access content fail in the later steps * Update .github/workflows/staging-deploy-pr-docker.yml Co-authored-by: James M. Greene <JamesMGreene@github.com> * Update .github/workflows/staging-deploy-pr-docker.yml Co-authored-by: James M. Greene <JamesMGreene@github.com> * Remove debugging step * Best practice: Use environment variables to avoid potential injection attacks if the data was user-controlled Co-authored-by: Mike Surowiec <mikesurowiec@users.noreply.github.com> Co-authored-by: Robert Sese <sese@github.com> Co-authored-by: Robert Sese <robert.sese@gmail.com>
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:
- 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:
- content/README.md
- content/graphql/README.md
- content/rest/README.md
- contributing/README.md
- data/README.md
- data/reusables/README.md
- data/variables/README.md
- includes/liquid-tags/README.md
- includes/README.md
- components/README.md
- lib/liquid-tags/README.md
- middleware/README.md
- script/README.md
- stylesheets/README.md
- tests/README.md
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.