Edit This Page

Staging Your Documentation Changes

This page shows how to stage content that you want to contribute to the Kubernetes documentation.

• Before you begin
• Staging from your GitHub account
• Staging a pull request
• Staging locally using Docker
• Staging locally without Docker
• What’s next

Before you begin

Create a fork of the Kubernetes documentation repository as described in Creating a Documentation Pull Request.

Staging from your GitHub account

GitHub provides staging of content in your master branch. Note that you might not want to merge your changes into your master branch. If that is the case, choose another option for staging your content.

1. In your GitHub account, in your fork, merge your changes into the master branch.

2. Change the name of your repository to <your-username>.github.io, where <your-username> is the username of your GitHub account.

3. Delete the CNAME file.

4. View your staged content at this URL:

    https://<your-username>.github.io
   

Staging a pull request

When you create pull request against the Kubernetes documentation repository, you can see your changes on a staging server.

1. In your GitHub account, in your new branch, submit a pull request to the kubernetes/kubernetes.github.io repository. This opens a page that shows the status of your pull request.

2. Click Show all checks. Wait for the deploy/netlify check to complete. To the right of deploy/netlify, click Details. This opens a staging site where you see your changes.

Staging locally using Docker

You can use the k8sdocs Docker image to run a local staging server. If you’re interested, you can view the Dockerfile for this image.

1. Install Docker if you don’t already have it.

2. Clone your fork to your local development machine.

3. In the root of your cloned repository, enter this command to start a local web server:

    docker run -ti --rm -v "$PWD":/k8sdocs -p 4000:4000 gcr.io/google-samples/k8sdocs:1.0
   

4. View your staged content at http://localhost:4000.

Staging locally without Docker

1. Install Ruby 2.2 or later.

2. Install RubyGems.

3. Verify that Ruby and RubyGems are installed:

    gem --version
   

4. Install the GitHub Pages package, which includes Jekyll:

    gem install github-pages
   

5. Clone your fork to your local development machine.

6. In the root of your cloned repository, enter this command to start a local web server:

    jekyll serve
   

7. View your staged content at http://localhost:4000.

What’s next

• Learn about writing a new topic.
• Learn about using page templates.
• Learn about creating a pull request.

Create an Issue Edit this Page