2.1 KiB

Raw Blame History

Development

This doc explains how to setup a development environment so you can get started contributing to Knative Docs. Also take a look at:

The pull request workflow

Prerequisites

Follow the instructions below to set up your development environment. Once you meet these requirements, you can make changes and

Before submitting a PR, see also CONTRIBUTING.md.

Start by creating a GitHub account, then setup GitHub access via SSH.

Checkout your fork

To check out this repository:

Create your own fork of this repo
Clone it to your machine:

mkdir -p ${GOPATH}/src/knative.dev
cd ${GOPATH}/src/knative.dev
git clone git@github.com:${YOUR_GITHUB_USERNAME}/docs.git
cd docs
git remote add upstream https://github.com/knative/docs.git
git remote set-url --push upstream no_push

Adding the upstream remote sets you up nicely for regularly syncing your fork.

Run website locally

Refer to this doc in the website repo.

Common Troubleshooting issues for PRs

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.
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.
Other Issues/Unsure - reach out in the #docs slack channel and someone will be happy to help out.

2.1 KiB Raw Blame History