Skip to content
Kong Docs are moving soon! Our docs are migrating to a new home. You'll be automatically redirected to the new site in the future. In the meantime, view this page on the new site!
|
Contribution guidelines
github-edit-pageEdit this page
report-issueReport an issue

Using variables

Use variable in content text, links, and in code blocks.

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 (for example, Admin API).
  • Page titles or headings.

Product names

For specific product name definitions and when to use what, see word choice and naming.

Variable Output Definition
{{site.base_gateway}} Kong Gateway The Kong API Gateway. Use this in most situations, especially when talking about a feature that is available in both open-source and Enterprise packages.
{{site.ee_product_name}} Kong Gateway Enterprise The whole self-managed Enterprise Gateway package, including modules and peripherals, e.g. Kong Manager, Enterprise plugins, etc. Use when you specifically need to refer to Enterprise functionality.
{{site.ce_product_name}} Kong Gateway (OSS) Kong’s open-source API gateway. Use when referring to something that’s only available in open-source.
{{site.konnect_product_name}} Kong Konnect The full name of Kong Konnect.
{{site.konnect_short_name}} Konnect The short name of the SaaS Konnect control plane.
{{site.mesh_product_name}} Kong Mesh The enterprise product offering built on top of CNCF’s Kuma.
{{site.kic_product_name}} Kong Ingress Controller The Kong Ingress Controller (KIC) for Kubernetes.
{{site.company_name}} Kong Inc. The name of the company.

Sometimes “Kong” is used to refer to Kong Gateway. For branding reasons, we should avoid using this term to refer to Kong Gateway going forward, however, user communities will continue to use this term as shorthand.
Variable Output Definition
{{site.links.learn}} https://education.konghq.com Link to the current location of Kong Academy or a similar education site.
{{site.links.download}} https://cloudsmith.io/~kong/repos Kong’s product download site.
{{site.links.web}} https://docs.konghq.com Kong Docs website.

Update or add variables

The product name variables are defined in the site config file, jekyll.yml.

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>