Contribution guidelines

Plugin docs

Plugin documentation is posted on the Plugin Hub. All plugin docs, whether developed by Kong or external contributors, follow a specific template.

We are currently accepting plugin submissions to our plugin hub from trusted technical partners, on a limited basis. For more information, see the Kong Partners page.

The Kong Plugin Hub is a documentation site. We do not host plugin source code or downloads.

Add a new plugin doc

Plugins created by Kong Inc

Create a subdirectory for the plugin within the _app/_hub/kong-inc directory. For example, _app/_hub/kong-inc/your-plugin.
Copy the /app/_hub/_init/my-extension/_index.md and the /app/_hub/_init/my-extension/versions.yml files into the plugin’s subdirectory.
Edit your _index.md file based on the guidance in comments in that file. You’ll also find lots of helpful examples in other plugin doc files.

If configuration parameters have default values, leave the required field blank for that parameter. The existence of a default value negates the requirement.
Edit your versions.yml file with the minimum Kong Gateway version that this plugin supports. This will generate a doc for every subsequent gateway version, starting with the one you specify.
Plugin icons are required for publication on the Kong plugin hub. Icons should be a square-format PNG file, 120x120 pixels in size.

The filename of your image should be publisher_plugin-name using the publisher and plugin name from step 2. For example, kong-inc_oas-validation.

Add the icon file to /app/_assets/images/icons/hub/.

Third-party or partner plugins

Set up or find your publisher directory in the docs repository.

If your company has not contributed a plugin to Kong before, create a publisher directory at_app/_hub/, such as _app/_hub/company-name.

See other Kong Hub listings for examples of publisher names.
Create a subdirectory for your plugin within the publisher directory. For example, _app/_hub/kong-inc/your-plugin.
Copy the /app/_hub/_init/my-extension/_index.md file into your plugin’s subdirectory.

Do not use the versions.yml file that also appears in the template directory. Kong does not maintain multiple versions of third-party plugin docs.
Edit the _index.md file based on the guidance in the comments in that file. You’ll also find lots of helpful examples in other plugin doc files.

If configuration parameters have default values, leave the required field blank for that parameter. The existence of a default value negates the requirement.
Plugin icons are required for publication on the Kong plugin hub. Icons should be a square-format PNG file, 120x120 pixels in size.

The filename of your image should be publisher_plugin-name using the publisher and plugin name from step 2. For example, my-company_oas-validation.

Add the icon file to the /app/_assets/images/icons/hub/ directory.

Test and submit plugin

Run the docs site locally per the instructions in the README - you should find your Hub contribution listed at localhost:3000/hub.
Once you are happy with your listing, push your branch to the GitHub repository
```
 git push --set-upstream origin [name_of_your_new_branch]
```
Make a pull request against the docs.konghq.com repository to add your documentation to the Plugin Hub.

The Kong docs team will review your PR, suggest improvements and adjustments as necessary, and once approved, will merge and deploy your Plugin Hub addition!

Custom plugins and documentation

If you want to write a custom plugin for your own needs, start by reading the Plugin Development Guide.

If you already wrote a plugin, and are thinking about making it available to the community, we strongly encourage you to host it on a publicly available repository (like GitHub), and distribute it via LuaRocks. A good resource on how to do so is the Distribution section of the Plugin Development Guide.

To give visibility to your plugin, you can create a post in the Announcements category of Kong Nation.