Skip to content
Kong Logo | Kong Docs Logo
search
  • We're Hiring!
  • Docs
    • Kong Gateway
    • Kong Konnect
    • Kong Mesh
    • Plugin Hub
    • decK
    • Kubernetes Ingress Controller
    • Insomnia
    • Kuma

    • Docs contribution guidelines
  • Plugin Hub
  • Support
  • Community
  • Kong Academy
Get a Demo Start Free Trial
  • Kong Gateway
  • Kong Konnect
  • Kong Mesh
  • Plugin Hub
  • decK
  • Kubernetes Ingress Controller
  • Insomnia
  • Kuma

  • Docs contribution guidelines
    • Style guide
    • Word choice and naming
    • Notes and other notices
    • Documenting user interfaces
    • Contribution templates
    • Plugin documentation
    • Markdown rules
    • Reusable content
    • Variables
    • Single-sourced versions
    • Single-sourced plugins
    • Conditional rendering
    • 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
  • Inclusive language
  • Accessibility
Contribution guidelines
  • Home
  • Style guide and contribution guidelines
  • Community expectations

Community expectations

This section outlines our community expectations around inclusive language and accessibility.

Inclusive language

Use inclusive language that does not exclude groups. Be aware of how impactful language is, and use it with care.

See: Microsoft’s Bias-free communication.

Accessibility

We are currently working on making our Docs site accessible in compliance with WCAG 2.1. Please ensure that all contributions do not derail from our goal. Overall, take into account the following for text-based contributions:

  • All non-decorative images have useful and descriptive text alternatives.
  • Avoid screenshots and use descriptive text instead.
  • Use clear, concise, and easy-to-understand language.
  • Organize content intentionally and make things easy to find.
  • Don’t get too experimental - stick to content and organization that’s predictable.

For code-based contributions, check the following:

  • All clickable elements can be tabbed through in a predictable sequence.
  • HTML is written:
    • without skipping header level (h1 to h2, instead of h1 to h3).
    • using the proper elements (li for lists instead of div).
  • No accessibility should be “hacked” by using JavaScript or other means. For example, don’t force tabbing (.on('keyup')). Instead, write HTML that tabs properly.
  • Color contrast is compatible with WCAG standards. Use a color contrast checker or Dev Tools.
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. 2023