Skip to content

Contributing to Documentation#

Documentation is essential part of developer experience for Gradle Build Tool users. All contributions are welcome!

Get Started#

  • Join the community Slack workspace
  • Use the #docs channel to discuss any documentation matters
  • If your pull request gets stuck, do not hesitate to ask in the #docs or #contributing channels


  • Gradle Build Tool - User Manual on
    • This site includes main Gradle documentation sources, including but not limited to: User Manual, DSL Reference, documentation for core plugins and Javadoc
    • Implementation: Asciidoc + custom documentation engine
    • Contributor Guide
  • Gradle Cookbook - a collection of recipes, guides and examples for the Gradle Build Tool.
    • This is an additional solution-based documentation
    • Implementation: MkDocs + Material for MkDocs
    • Contributor Guide
  • Plugin documentation - Documentation for the key plugins is provided by the Gradle Build Tool repo. For other plugins, see their repositories for the docs and contributing guidelines.
    • Implementation: most plugins use simple documentation pages in GitHub-flavored Markdown (
  • Gradle Community Site - Community resources, including Gradle Cookbook and top-level Gradle Contributor Guide


In Gradle we use a diverse set of tooling for documentation development. We use both Markdown and Asciidoc for writing, with MkDocs, Jekyll, and the Gradle Asciidoc Plugin as our main tools for documentation. Additionally, we utilize other tools such as Dokka, Javadoc, and OpenAPI specifications.

Many small patches can be just submitted from the GitHub web editor. For bigger patches and local development, see the referenced contributing guidelines.

Private source locations#

Please note that some of locations are private source at the moment. It includes:

  • The main site (
  • The official blog (
  • The newsletter archive (
  • Gradle guides and most of training courses (

If you want to submit patches to any of those locations, please reach out to us on the #docs channel.