ithesadson/keda-docs

Documentation and landing page for KEDA

KEDA - Docs

Documentation and landing page for the KEDA project at 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:

1. Upload your logo to static/img/logos/ (350x180)
2. 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!

Become a listed KEDA commercial offering!

Do you offer commercial support for KEDA and want to become a listed commercial offering? Say no more!

You can easily get listed by following these steps:

1. Upload your logo to static/img/logos/ (350x180)
2. Configure your company as a new user in config.toml (sorted alphabetically)

[[params.vendors]]
url = "https://cloud.redhat.com/blog/custom-metrics-autoscaler-on-openshift"
logo = "red-hat.png"

Building or serving the site locally

To build or serve the site locally, follow these steps:

• Fork and clone this repository (for local development only).
• Install the latest LTS release of Node, using nvm for example:

  $ nvm install --lts

  Note: on Windows, the argument to install is lts.
• Get npm packages and other prerequisites:

  $ npm install

• To build the site, run:

  $ npm run build

  You'll find the generated site files under public.
• Serve the site locally at localhost:8888 using:

  $ npm run serve

Contributing

We welcome issues and PRs! For details, see Contributing to KEDA.

If you submit a PR, Netlify will automatically create a deploy preview so that you can view your changes. Once merged, Netlify automatically deploys to the production site keda.sh.

To see deploy logs and more, visit project's dashboard -- Netlify login required.

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 (in YYYY-MM-DD format)
• author

Adding scaler documentation

To add documentation for a new KEDA scaler:

$ hugo new --kind scaler docs/<VERSION>/scalers/my-new-scaler.md

This creates a boilerplate Markdown file in content/docs/<VERSION>/scalers/my-new-scaler.md whose contents you can modify. Make sure to update the following metadata fields:

• title
• availability
• maintainer
• description

Writing documentation for a new authentication provider

To add documentation for a new provider:

$ hugo new --kind provider docs/<VERSION>/providers/my-new-provider.md

This creates a boilerplate Markdown file in content/docs/<VERSION>/providers/my-new-provider.md whose contents you can modify. Make sure to update the following metadata fields:

• title

Writing documentation for a scaler

In order to maintain the style consistency across different scalers, all the parameters which are listed have to be written using this convention:

• name - Description. (Values: x, y, z, Default: y, Optional, Extra Info)

If a parameter is required or doesn't have defined/default values, the missing info should be removed from the pattern.

Here are a few examples:

• targetMetricValue - Target value for your metric.
• metricFilter - Aggregation method of the metric. (Values: max, min, average, sum, variance, Default: average, Optional)
• metricPeriod - Granularity of the metric. (Default: 300, Optional)
• subscriptionName - Name of the Azure Service Bus queue to scale on. (Optional, Required when topicName is specified)

Add new Frequently Asked Question (FAQ)

To update the KEDA FAQ page, update the TOML file at data/faq20.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/<CurrentVersion> content/docs/<NewVersion>

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.

Preparing a new version

Remember to create the folder for next version with already existing docs in current version.

Make sure that the version on content/docs/{next-version}/deploy.md is updated and uses the next version, instead of the current one.

Ensure that compatibility matrix on content/docs/{next-version}/operate/cluster.md is updated with the compatibilities for the incoming 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).

Note: Remember to prepare the next version.