👩🏻🏫 Summary
This guide instructs you on how to label your doc PR.
When submitting an issue or PR, you must provide doc label information by selecting the checkbox, so that the Bot can label the PR correctly.
| Label name | Usage |
|---|---|
doc-required |
Use this label to indicate this issue or PR impacts documentation. You have not updated the docs yet. The docs will be submitted later. |
doc-not-needed |
The code changes in this PR do not impact documentation. |
doc |
This PR contains changes that impact documentation, no matter whether the changes are in markdown or code files. |
doc-complete |
Use this label to indicate the documentation updates are complete. |
doc-label-missing |
The Bot applies this label when there is no doc label information in the PR if one of the following conditions is met:. - You do not provide a doc label. - You provide multiple doc labels. - You delete backticks (``) in doc labels. For example, [x] doc-required ✅ [x] doc-required ❌ - You add blanks in square brackets. For example, [x] `doc-required` ✅ [ x ] `doc-required` ❌ |
For more guides on how to make contributions to Pulsar docs, see Pulsar Documentation Contribution Overview.