Getting started

From zero to docs deployed on Netlify in just a few minutes

If you’re working on a new Cloud Native Computing Foundation (CNCF) project, an older project that wants to revamp its site and docs, or a project that’s not affiliated with the CNCF at all, you can deploy a project by:

Install dependencies

macOS

brew install hugo

Make sure to install the version of Hugo specified in the netlify.toml configuration file.

Clone the repo

To get started:

git clone https://github.com/cncf/site-boilerplate && cd site-boilerplate

Create a new repo

In order to publish your Docs in a Box project on Netlify, create a new GitHub repo for the project.

Run your project locally

To run the project locally:

make serve

Navigate to http://localhost:1313 in your browser and you should see this exact same site up and running locally!

Set up Netlify

Netlify is the default publishing platform for CNCF projects.

To run your project on Netlify:

  • Create a Netlify account
  • Create a new Netlify project
  • Link the project to your