We use a Jekyll plugin (
plugin_single_source_generator.rb) to dynamically generate pages from a single source file.
Here’s how it works:
- Read all version files (
- For each version listed in the file, check if
- If not, read
app/_hub/[vendor]/[name]/_index.md and generate a version of the page.
- The latest version is always generated as
index.html, while older versions are generated as
Automatic plugin versioning
versions.yml is expected to contain a
strategy and a list of
maximum_version: '3.0.x' # optional
Which reads all available Gateway versions from
kong_versions.yml and selects those that are in the specified range.
strategy supports either
matrix for the original rendering, or
gateway for plugins that have versions pinned to the Gateway version,
matrix option is no longer in use. It remains at the moment for backwards compatibility.
This can also be used with
overrides to set a custom plugin version name:
Open source and enterprise discrepancies
In some cases, the version of a plugin is different between the Community Edition (OSS) and Enterprise Edition.
In these instances, each release should be entered as a unique version in the config file.
Here’s an example where Gateway 2.3.x CE uses plugin version 1.0, while 2.3.x EE uses plugin version 2.0:
2.4.x both use plugin version
2.0.x and the default
_index source file.
2.2.x use plugin version
1.0.x and the
_1.0 source file.
If you want to use
releases but have one or two versions that you need to override, you can use