momo-jun commented on code in PR #18071: URL: https://github.com/apache/pulsar/pull/18071#discussion_r997642116
########## site2/doc-guides/contribution.md: ########## @@ -0,0 +1,219 @@ +# Pulsar Documentation Contribution Guide + +> 👩🏻🏫 **Summary** +> +> This guide explains the organization of Pulsar documentation and website repos and the workflow of updating various Pulsar docs. + + +**TOC** + +<!-- TOC --> + +- [Pulsar Documentation Contribution Guide](#pulsar-documentation-contribution-guide) + - [Documentation and website repos](#documentation-and-website-repos) + - [Intro to doc and website repos](#intro-to-doc-and-website-repos) + - [Relationships between doc and website repos](#relationships-between-doc-and-website-repos) + - [Update versioned docs](#update-versioned-docs) + - [Update reference docs](#update-reference-docs) + - [Update Pulsar configuration docs](#update-pulsar-configuration-docs) + - [Update client configuration docs](#update-client-configuration-docs) + - [Update CLI tool docs](#update-cli-tool-docs) + - [Update client/function matrix](#update-clientfunction-matrix) + - [References](#references) + +<!-- /TOC --> + +## Documentation and website repos + +This chapter shows the organization of Pulsar documentation and website repos Review Comment: ```suggestion This chapter shows the organization of Pulsar documentation and website repos. ``` -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
