Using Variables
The product name variables are defined in the site config file, jekyll.yml:
# product name vars
ee_gateway_name: Kong Gateway
ee_product_name: Kong Gateway (Enterprise)
ce_product_name: Kong Gateway (OSS)
base_gateway: Kong Gateway
mesh_product_name: Kong Mesh
kic_product_name: Kubernetes Ingress Controller
konnect_product_name: Kong Konnect
konnect_short_name: Konnect
konnect_saas: Konnect SaaS
package_name: Kong Konnect
company_name: Kong Inc.
# Konnect tier vars
free_tier: Kong Gateway
plus_tier: Kong Konnect Plus
enterprise_tier: Kong Konnect Enterprise
If you need to update the variable text, add, or remove a variable, edit
jekyll.yml and jekyll-dev.yml in the root of the site repository.
For a new variable, use the following syntax: <variable>:<output>
Do: use in content text, in links, in codeblocks.
Do not use in:
-
Page front matter: This is an important note for plugins in particular, as much of the page content is generated out of a plugin’s front matter.
-
Auto-generated docs (eg Admin API).
-
Page titles or headings.
Product names
| Variable | Output | Definition | Syntax |
|---|---|---|---|
| base_gateway | Kong Gateway | The base API gateway. Use this when talking about a feature that is available for both Community and Enterprise. | {{site.base_gateway}} |
| ee_product_name | Kong Gateway (Enterprise) | The whole self-hosted Enterprise Gateway package, including modules and peripherals, eg Kong Manager, Dev Portal, Vitals, etc. | {{site.ee_product_name}} |
| ce_product_name | Kong Gateway (OSS) | Kong’s open-source API gateway. | {{site.ce_product_name}} |
| konnect_product_name | Kong Konnect | The full name of the Kong Konnect platform, cloud and self-hosted. | {{site.konnect_product_name}} |
| konnect_short_name | Konnect | The short name of the SaaS Konnect control plane. | {{site.konnect_short_name}} |
| konnect_saas | Konnect Cloud | The full name of the SaaS Konnect control plane. | {{site.konnect_saas}} |
| company_name | Kong Inc. | The name of the company. Do not use “Kong” without a modifier to refer to Kong Gateway. Kong refers only to the company. |
{{site.company_name}} |
Versions
WORK IN PROGRESS
kong_version
Depends on the page
The release-level version of the page that you’re on - eg 1.5.x, 1.3-x.
variables.md
Use this variable in links, eg:
/enterprise/variables.md/introduction
page.kong_latest.version
Depends on current release
The latest real version of the product on the page (eg 2.1.0.2)
page.kong_latest.release
Depends on current release
The URL and folder name of the latest version (eg 2.1.x) for the product on the page.
page.kong_versions[x].version
Outputs the specified version in the array
Turns the list of versions into an array and pulls the specified version.
E.g., if you want to pull the first version of the doc, you would use , if you want to use the third published version, you would use , etc