Good documentation is crucial for any kind of software. This is especially true for sophisticated software systems such as distributed messaging system like Apache Pulsar. The Apache Pulsar community aims to provide concise, precise, and complete documentation and welcomes any contribution to improve Apache Pulsar's documentation.
This introduction provides a set of guides offering best-practice suggestions for contributing documentation to Pulsar. It provides detailed instructions on the contribution workflow and conventions. Please follow these guidelines to keep the documentation structure, style, and syntax consistent.
- How to update document
- Writing Syntax Guide
- Writing Style Guide
- Design Style Guide
- API Documentation Guide
Pull request process
In addition, the following resources can help you craft and contribute to docs: