Skip to content
Kong Summit 2022: Where API Innovation Runs Wild  —Learn More →
Kong Logo | Kong Docs Logo
search
  • We're Hiring!
  • Docs
    • Kong Gateway
    • Konnect Cloud
    • Kong Mesh
    • Plugin Hub
    • decK
    • Kubernetes Ingress Controller
    • Insomnia
    • Kuma

    • Kong Konnect Platform

    • Docs contribution guidelines
  • Plugin Hub
  • Support
  • Community
  • Kong Academy
Request Demo
  • Kong Gateway
  • Konnect Cloud
  • Kong Mesh
  • Plugin Hub
  • decK
  • Kubernetes Ingress Controller
  • Insomnia
  • Kuma

  • Kong Konnect Platform

  • Docs contribution guidelines
    • Style guide
    • Word choice and naming
    • Markdown rules
    • Reusable content
    • Variables
    • Welcome to the Kong Docs community
    • Community expectations
    • Hackathons

github-edit-pageEdit this page

report-issueReport an issue

enterprise-switcher-iconSwitch to OSS

On this page
  • Product names
  • Links
  • Update or add variables
Contribution guidelines
  • Home
  • Style guide and contribution guidelines

Using Variables

Use variable in content text, links, and 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

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, including:

• When talking about a feature that is available for both open-source and Enterprise
• When referring to the Enterprise image used in any mode, with a license or without.
{{site.ee_product_name}} Kong Gateway (Legacy variable, do not use) The whole self-managed Enterprise Gateway package, including modules and peripherals, eg Kong Manager, Dev Portal, Vitals, etc.
{{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 the Kong Konnect platform, both cloud and self-managed.
{{site.konnect_short_name}} Konnect The short name of the SaaS Konnect control plane.
{{site.konnect_saas}} Konnect Cloud The full name of the SaaS Konnect control plane.
{{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.

Links

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://download.konghq.com 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>

Thank you for your feedback.
Was this page useful?
  • Kong
    THE CLOUD CONNECTIVITY COMPANY

    Kong powers reliable digital connections across APIs, hybrid and multi-cloud environments.

    • Company
    • Customers
    • Events
    • Investors
    • Careers Hiring!
    • Partners
    • Press
    • Contact
  • Products
    • Kong Konnect
    • Kong Gateway
    • Kong Mesh
    • Get Started
    • Pricing
  • Resources
    • eBooks
    • Webinars
    • Briefs
    • Blog
    • API Gateway
    • Microservices
  • Open Source
    • Install Kong Gateway
    • Kong Community
    • Kubernetes Ingress
    • Kuma
    • Insomnia
  • Solutions
    • Decentralize
    • Secure & Govern
    • Create a Dev Platform
    • API Gateway
    • Kubernetes
    • Service Mesh
Star
  • Terms•Privacy
© Kong Inc. 2022