Skip to content
2023 API Summit Hackathon: Experiment with AI for APIs (August 28 - September 27) Learn More →
Kong Logo | Kong Docs Logo
search
  • We're Hiring!
  • Docs
    • Kong Gateway
      Lightweight, fast, and flexible cloud-native API gateway
      Kong Konnect
      Single platform for SaaS end-to-end connectivity
      Kong Mesh
      Enterprise service mesh based on Kuma and Envoy
      decK
      Helps manage Kong’s configuration in a declarative fashion
      Kong Ingress Controller
      Works inside a Kubernetes cluster and configures Kong to proxy traffic
      Insomnia
      Collaborative API development platform
      Kuma
      Open-source distributed control plane with a bundled Envoy Proxy integration
      Docs Contribution Guidelines
      Want to help out, or found an issue in the docs and want to let us know?
  • API Specs
  • Plugin Hub
    • Explore the Plugin Hub
      View all plugins View all plugins View all plugins arrow image
    • Functionality View all View all arrow image
      View all plugins
      Authentication's icon
      Authentication
      Protect your services with an authentication layer
      Security's icon
      Security
      Protect your services with additional security layer
      Traffic Control's icon
      Traffic Control
      Manage, throttle and restrict inbound and outbound API traffic
      Serverless's icon
      Serverless
      Invoke serverless functions in combination with other plugins
      Analytics & Monitoring's icon
      Analytics & Monitoring
      Visualize, inspect and monitor APIs and microservices traffic
      Transformations's icon
      Transformations
      Transform request and responses on the fly on Kong
      Logging's icon
      Logging
      Log request and response data using the best transport for your infrastructure
  • Support
  • Community
  • Kong Academy
Get a Demo Start Free Trial
Contribution guidelines
  • Home icon
  • Style guide and contribution guidelines
  • Contributing to the Kong docs
github-edit-pageEdit this page
report-issueReport an issue
  • Kong Gateway
  • Kong Konnect
  • Kong Mesh
  • Plugin Hub
  • decK
  • Kong Ingress Controller
  • Insomnia
  • Kuma

  • Docs contribution guidelines
enterprise-switcher-icon Switch to OSS
On this pageOn this page
  • What we’re looking for
  • How to contribute
    • Content requirements
    • Build locally
    • First-time contributors
    • Git/GitHub resources
    • Contributor T-shirt

Contributing to the Kong docs

Hello, and welcome! Thanks for thinking about contributing to the Kong documentation.

This section of the docs is here to help you help us, so read on to learn how to ask questions and help effectively. We respect your time, and the more you follow our guidelines the easier it is for us (docs maintainers) to respond promptly and help you get your pull requests merged.

What we’re looking for

We welcome fixes to unclear prose, fixes to typos in docs for recent versions, docs for new features you’ve contributed to the code, and more.

We are currently accepting plugin submissions, on a limited basis, from trusted technical partners to our plugin hub. To learn more about our partner program, see our Kong Partners page.

Explore the existing documentation before you start a big docs contribution. Some types of docs don’t belong on the site, including: end-to-end guides, tutorials, and anything better suited to a blog post. If you’re interested in this kind of content or have support questions, join the community on Kong’s forum, on Gitter, or on IRC at #kong.

We can’t provide product support in this repository. To report Kong Gateway bugs, visit the Kong product contributing guide.

How to contribute

We adhere to our own code of conduct and we expect the same of our contributors.

If you find a problem in the docs, you can file an issue or you can submit a pull request (PR) with a fix. Please fill out the issue or PR template! We can’t help if we don’t understand the problem.

The Kong docs team assigns someone to review PRs every day, so you can expect acknowledgment of your contribution and at least preliminary feedback within about a day of your initial PR. We ask that you respond to feedback within a week if we ask for changes; otherwise, we’ll close your issue or PR, although you can always reopen it to finish your work.

If you fix a typo, be sure to check for it everywhere, not just in the one instance you found. Currently docs for each version live in separate directories, not branches, and not much content changes from version to version. Chances are good that a typo on a page in one version appears on the same page in other versions too.

Content requirements

Before you change anything except for typos or grammatical errors, explore these resources:

  • Our style guide provides a minimal set of style guidelines.
  • Our set of markdown rules for making your content work with our Jekyll implementation. Specifies how you must work with certain kinds of content - includes, variables, new pages.
  • Our list of Kong-specific terms. Includes product names and other terms the Kong docs use in specific ways.
  • Our documentation templates. You can use these templates to create new documentation pages.

Build locally

Updates to the Kong docs main branch are automatically published with our Netlify integration. We also work with Netlify preview deploys, so when you create a pull request on GitHub, Netlify automatically provides a preview build that includes your changes.

If you are making substantial changes, we ask that you build locally before you create your PR. This lets you run tests locally, and helps you fix any build errors before working with Netlify.

See the Kong docs README for instructions to set up and build locally.

First-time contributors

Fork the repository and create an appropriately named branch before you start working on any substantial changes.

Git/GitHub resources

If you’re new to Git and GitHub, we suggest you take some time with some of the great resources for learning these tools. Their basic purpose is version control, but they were made to support open source projects, so their design and implementation might be different from what you’re used to. Resources we’ve found helpful, with thanks to the Write the Docs newsletter:

  • Learn Git in a Month of Lunches (book). Recommended by the Write the Docs community as a great “how to be productive with Git” tutorial.
  • Pro Git (book).
  • Git Immersion (open-source online course).
  • Git and GitHub for Poets (YouTube series, course).

Or consider a GUI client instead of the command line, such as GitHub Desktop, TortoiseGit (Windows), Tower, Sourcetree, or GitKraken.

If you’re making small spelling or grammar changes, you’re welcome to skip the whole learn-Git-fork-branch-work-locally flow and make your changes directly in the GitHub web UI. The UI takes care of forking/branching automatically, so you don’t need to worry about it. Because we work with deploy previews in Netlify, this approach means you also don’t need to worry about building locally before you submit your PR.

Contributor T-shirt

If your contribution to this repository was accepted and fixes a bug, adds functionality, or makes it significantly easier to use or understand Kong, congratulations! You are eligible to receive the very special Contributor T-shirt! Fill out the Contributors Submissions form and we’ll get it to you!

Thank you for contributing!

Thank you for your feedback.
Was this page useful?
Too much on your plate? close cta icon
More features, less infrastructure with Kong Konnect. 1M requests per month for free.
Try it for Free
  • 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. 2023