KEDA - Docs
Documentation and landing page for the KEDA project at https://keda.sh.
Become a listed KEDA user!
Are you using KEDA in production? Do you want to become a listed user? Say no more!
You can easily get listed by following these steps:
- Upload your logo to
static/img/logos/
(350x180) - Configure your company as a new user in
config.toml
(sorted alphabetically)
[[params.users]]
url = "https://coralogix.com/"
logo = "coralogix.gif"
Here's a good example of Coralogix becoming a listed user!
Running the site locally
Install Hugo (the "extended" version with Hugo Pipes support) and Yarn:
Windows
choco install hugo-extended
choco install yarn
Mac
brew install hugo
brew install yarn
Now you can run the docs locally:
yarn
hugo server -D -F
Publishing the site
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.
Adding blog posts
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
Adding scaler documentation
To add documentation for a new KEDA scaler:
hugo new --kind scaler scalers/<VERSION>/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
Add new Frequently Asked Question (FAQ)
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! 😀"
Add new troubleshooting guidance
To add a new section to the troubleshooting page:
hugo new troubleshooting/<VERSION>/my-new-issue.md
To adjust the order in which the troubleshooting tiles appear, use the weight
parameter in each page's metadata.
Working with documentation versions
The KEDA documentation is versioned. Each version has its own subdirectory under content/docs
. To add a new version, copy the directory for the most recent version. Here's an example:
cp -rf content/docs/2.0.0 content/docs/2.1.0
By default, new documentation versions are not listed as available version so it's safe to make changes to them. After every release, the version will be published as new version.
Publishing a new version
Once a version is ready to be published, we must add the version to the params.versions.docs
list in config.toml
.
More recent versions should be placed first in the list (ordering does matter because the first element in that list is considered the latest version).