Tinkerbell

For complete documentation visit tinkerbell.org

Tinkerbell is a bare metal provisioning engine. It’s built and maintained with love by the Tinkerbell Community.

Contributing

This website uses Hugo to generate static HTML pages. It's hosted and automatically build by Netlify (see netlify.toml for more details).

• content/ directory contains documentation files
• hugo.toml is the Hugo configuration
• netlify.toml is Netlify configuration

Build the site locally

Clone the repository:

git clone https://github.com/tinkerbell/tinkerbell.org
cd tinkerbell.org

Using Netlify CLI (recommended)

The Netlify CLI provides the most accurate local preview, including support for redirects defined in netlify.toml.

1. Install the Netlify CLI:

   npm install -g netlify-cli

2. Start the development server:

   netlify dev

Site can be viewed at http://localhost:8888

Using Hugo directly

Alternatively, you can use Hugo directly. Note that some features like redirects may not work identically to production.

1. Install Hugo (v0.155.1 or later)

2. Start the development server:

   hugo server -D

Site can be viewed at http://localhost:1313

Making changes

Adding a new documentation page

# example: adding new documentation page under section
hugo new section/name-of-new-page.md

Modifying an existing documentation page

Find the documentation page file (.md file) under content/ and edit it.

Publishing your changes

Create a Pull Request with your changes. When the PR is merged site will be updated automatically by Netlify.

Licensing

The code snippets and the documentation is licensed under Apache license. See LICENSE for the full license text.