KONG's Documentation Website

This repository is the source code for Kong's documentation website. It is a Jekyll website hosted on GitHub pages.

Hacktoberfest Guidelines 🦍 🎃

Thank you for contributing to Kong’s documentation!

Not sure where to start? Head on over to the issues tab to and look for the good first issue label. These are issues Kong has identified as beginner friendly. Many of these can be addressed through Github and do not require pulling the repository and building locally.

Develop Locally With Docker

make develop

Testing Links With Docker

make check-links

Develop Locally Without Docker

Prerequisites

• npm
• Bundler (< 2.0.0)
• Ruby (>= 2.0, < 2.3)
• Python (>= 2.7.X, < 3)

Install

gem install bundler
npm install

Running

npm start

Search

We are using Algolia docsearch for our documentation search. The algolia index for Kong is maintained by Algolia through their docsearch service. Their scraper runs every 24 hours. The config used by the scraper is open source for docs.konghq.com and can be found here. To update the scraper config, you can submit a pull request to the config. To test a config change locally, you will need to run their open source scraper against your own scraper to test out config changes.

Generating the Plugin Development Kit documentation

• Have a local clone of Kong
• Install Luarocks (comes with Kong)
• Install ldoc using Luarocks: luarocks install ldoc 1.4.6
• In the Kong repository, check out the desired branch/tag/release
• Run: KONG_PATH=path/to/your/kong/folder KONG_VERSION=0.14.x gulp pdk-docs
• This command will attempt to:
  • Obtain an updated list of modules from your local PDK and put it inside your nav file
  • Generate documentation for all the modules in your PDK (where possible) and put in a folder inside your version docs

Generating the Admin API, CLI and Configuration Documentation

• Make sure that the resty and luajit executables are in your $PATH (installing kong should install them)
• Several Lua rocks are needed. The easiest way to get all of them is to execute make dev in the Kong folder
• Have a local clone of Kong
• In the Kong repository, check out the desired branch/tag/release
• To generate the Admin API docs:
  • Run: KONG_PATH=path/to/your/kong/folder KONG_VERSION=0.14.x gulp admin-api-docs
  • This command will attempt to:
    • Compare Kong's schemas and Admin API routes with the contents of the file autodoc-admin-api/data.lua and error out if there's any mismatches or missing data.
    • If no errors were found, a new admin-api.md file will be generated in the path corresponding to the provided KONG_VERSION.
• To generate the CLI docs:
  • Run: KONG_PATH=path/to/your/kong/folder KONG_VERSION=0.14.x gulp cli-docs
  • This command will:
    • Extract the output of the --help for every kong CLI subcommand
    • Generate a new cli.md in the path corresponding to the provided KONG_VERSION.
• To generate the Configuration docs:
  • Run: KONG_PATH=path/to/your/kong/folder KONG_VERSION=0.14.x gulp conf-docs
  • This command will:
    • Parse Kong's kong.conf.default file and extract sections, variable names, descriptions, and default values
    • Write those down inside a configuration.md file in the path matching KONG_VERSION.
    • The command will completely overwrite the file, including text before and after the list of vars.
    • The data used for the before/after parts can be found in autodoc-conf/data.lua

Listing Your Extension in the Kong Hub

We encourage developers to list their Kong plugins and integrations (which we refer to collectively as "extensions") in the Kong Hub with documentation hosted on the Kong website for ready access.

See CONTRIBUTING for more information.