Skip to content

Latest commit

 

History

History
 
 

site2

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 
 
 

Pulsar Documentation Contribution Overview

As you start your Pulsar journey, you might don’t understand something or make mistakes. Don’t worry and take it easy. The Pulsar community is a joint effort based on respect, openness, friendliness, discussions, and consensus. Everyone is encouraged to contribute and any help is appreciated!

The Pulsar Documentation Contribution Overview 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.

Before writing docs

Writing docs

Testing docs

Preparing to submit doc PRs

References

In addition, the following resources can help you craft and contribute to docs.