|
| 1 | +# Development |
| 2 | + |
| 3 | +This doc explains how to setup a development environment so you can get started |
| 4 | +[contributing](https://www.knative.dev/contributing/) to `Knative Docs`. Also |
| 5 | +take a look at: |
| 6 | + |
| 7 | +- [The pull request workflow](https://www.knative.dev/contributing/contributing/#pull-requests) |
| 8 | + |
| 9 | +## Prerequisites |
| 10 | + |
| 11 | +Follow the instructions below to set up your development environment. Once you |
| 12 | +meet these requirements, you can make changes and |
| 13 | + |
| 14 | +Before submitting a PR, see also [CONTRIBUTING.md](./CONTRIBUTING.md). |
| 15 | + |
| 16 | +### Sign up for GitHub |
| 17 | + |
| 18 | +Start by creating [a GitHub account](https://github.com/join), then setup |
| 19 | +[GitHub access via SSH](https://help.github.com/articles/connecting-to-github-with-ssh/). |
| 20 | + |
| 21 | +### Checkout your fork |
| 22 | + |
| 23 | +To check out this repository: |
| 24 | + |
| 25 | +1. Create your own |
| 26 | + [fork of this repo](https://help.github.com/articles/fork-a-repo/) |
| 27 | +1. Clone it to your machine: |
| 28 | + |
| 29 | +```shell |
| 30 | +mkdir -p ${GOPATH}/src/knative.dev |
| 31 | +cd ${GOPATH}/src/knative.dev |
| 32 | +git clone [email protected]: ${YOUR_GITHUB_USERNAME}/docs.git |
| 33 | +cd docs |
| 34 | +git remote add upstream https://github.com/knative/docs.git |
| 35 | +git remote set-url --push upstream no_push |
| 36 | +``` |
| 37 | + |
| 38 | +_Adding the `upstream` remote sets you up nicely for regularly |
| 39 | +[syncing your fork](https://help.github.com/articles/syncing-a-fork/)._ |
| 40 | + |
| 41 | +### Common Troubleshooting issues for PRs |
| 42 | + |
| 43 | +1. The CLA check fails even though you have signed the CLA. This may occur if you accept and commit suggestions in a pull request from another person's account, because the email address of that account doesn't match the address on record for the CLA. The commit will show up as co-authored, which can cause issues if your public email address has not signed the CLA. |
| 44 | + |
| 45 | +1. One or more tests are failing. If you do not see a specific error related to a change you made, and instead the errors are related to timeouts, try rerunning the test at a later time. There are running tasks that could result in timeouts or rate limiting if your test runs at the same time. |
| 46 | + |
| 47 | +1. Other Issues/Unsure - reach out in the #docs slack channel and someone will be happy to help out. |
0 commit comments