You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@pulsar.apache.org by Yu <li...@apache.org> on 2022/10/19 10:27:32 UTC

Doc Contribution Guides are available in Pulsar repos!

Hi community,

Recently, I've submitted the following doc contribution guides to the
Pulsar GitHub repos [1].

They provide a set of guides offering best-practice suggestions for
contributing documentation to Pulsar with detailed instructions on the
contribution workflow and conventions.

Please follow these guidelines to keep the documentation structure, style,
and syntax consistent.

>>>>>>>>>>>>

# Before writing docs
- Pulsar Documentation Contribution Guide
    - Doc structure and project organization
    - Workflow of submitting various docs

# Writing docs
- Pulsar Documentation Writing Syntax Guide
- Pulsar Documentation Writing Style Guide
- Pulsar Design Style Guide
- Pulsar API Documentation Guide

# Testing docs
- Pulsar Content Preview Guide

# Preparing to submit doc PRs
- Pulsar Pull Request Naming Convention Guide
- Pulsar Documentation Label Guide

# Other
- Pulsar Release Note Guide [2]

[1] https://github.com/apache/pulsar/tree/master/site2
[2]
https://github.com/apache/pulsar/blob/master/wiki/release/release-note-guide.md

>>>>>>>>>>>>

Feel free to comment if you have any suggestions or concerns.

Many thanks for your technical guidance! @urfreespace,
@signormercurio, @tisonkun, @nodece

Yu