Documentation and landing page for the KEDA project at https://keda.sh.
Install Hugo (the "extended" version with Hugo Pipes support) and Yarn:
choco install hugo-extended
choco install yarn
brew install hugo
brew install yarn
Now you can run the docs locally:
yarn
hugo server -D -F
The KEDA website is published automatically by Netlify. Any time changes to this repo are pushed to master
, the site is re-built and re-published in roughly two minutes.
To add a new post to the Keda blog:
hugo new blog/my-new-post.md
This creates a boilerplate Markdown file in content/blog/my-new-post.md
whose contents you can modify. The following fields are required:
title
date
(inYYYY-MM-DD
format)author
To add documentation for a new KEDA scaler:
hugo new --kind scaler docs/scalers/my-new-scaler.md
This creates a boilerplate Markdown file in content/docs/scalers/my-new-scaler.md
whose contents you can modify. Make sure to update the following metadata fields:
title
availability
maintainer
description
To update the KEDA FAQ page, update the TOML file at [data/faq.toml
]. Here's an example question/answer pair:
[[qna]]
q = "How can I add a new question/answer pair?"
a = "You're looking at it! 😀"
To add a new section to the troubleshooting page:
hugo new troubleshooting/my-new-issue.md
To adjust the order in which the troubleshooting tiles appear, use the weight
parameter in each page's metadata.