About the Documentation

Stephane Maldini <@smaldini>; Violeta Georgieva <@violeta_g_g> Version 1.2.1

This section provides a brief overview of Reactor Netty reference documentation. You do not need to read this guide in a linear fashion. Each piece stands on its own, though they often refer to other pieces.

The Reactor Netty reference guide is available as HTML documents. The latest copy is available at projectreactor.io/docs/netty/release/reference/index.html

Copies of this document may be made for your own use and for distribution to others, provided that you do not charge any fee for such copies and further provided that each copy contains this Copyright Notice, whether distributed in print or electronically.

2. Contributing to the Documentation

The reference guide is written in Asciidoc using Antora, and you can find its sources at github.com/reactor/reactor-netty/tree/main/docs.

If you have an improvement, we will be happy to get a pull request from you!

We recommend that you check out a local copy of the repository so that you can generate the documentation by using the asciidoctor Gradle task and checking the rendering. Some of the sections rely on included files, so GitHub rendering is not always complete.

To facilitate documentation edits, you can edit the current page from the Edit this Page link located in the upper right corner sidebar. The link opens an edit UI directly on GitHub for the main source file for the current page. These links are only present in the HTML5 version of this reference guide. They look like the following link: Edit this Page to make changes to About the Documentation page.

3. Getting Help

There are several ways to reach out for help with Reactor Netty. You can:

  • Get in touch with the community on Gitter.

  • Ask a question on stackoverflow.com at reactor-netty.

  • Report bugs in Github issues. The repository is the following: reactor-netty.

All of Reactor Netty is open source, including this documentation.