Skip to content

README.md

Latest commit

 

History

History
45 lines (28 loc) · 1.66 KB

README.md

File metadata and controls

45 lines (28 loc) · 1.66 KB

kpt Documentation Site

UPDATE ME

This directory contains a Hugo web site published via Netlify to https://update-me/.

When the main branch of this repo is updated a fresh build and deploy of the website is executed. Recent Netlify builds and deployments are listed at https://app.netlify.com/sites/update-me.

Add content by adding Markdown files to directories in ./content.

Update layouts for each content type in ./layouts.

Configuration is set in config.toml.

Setting up a local dev instance

To set up a local dev environment make sure you have npm installed, then run the following from this folder:

npm install

Then run the site using npm run serve. To have the site run locally with a functioning local search, run npm run serve:with-pagefind.

API Token for Version Fetching

The documentation site fetches the latest release versions of KRM functions from the GitHub API. To avoid rate limiting, set the KRM_CATALOG_API_TOKEN environment variable with a GitHub personal access token (no scopes required for public repos).

  • export KRM_CATALOG_API_TOKEN=<your-token> before running npm run serve.

The token is optional. Without it, unauthenticated API requests are subject to lower rate limits, which may cause version information to be unavailable during builds.

License

Licensed under the Creative Commons Attribution 4.0 International license