Anonymitaet commented on PR #17853: URL: https://github.com/apache/pulsar/pull/17853#issuecomment-1274299184
> @Anonymitaet Thanks for the reminder again. Here is a very interesting point. When you told me last time that I needed to attach a screenshot of the preview, I understood the preview from the perspective of a technician, so I attached a screenshot of the successful deployment of the cluster. But in fact, you meant to attach a preview screenshot of the document/website. I think this question may also confuse other newcomers. To solve this problem, I have a small suggestion about the description template. > > ``` > ### Documentation > > <!-- DO NOT REMOVE THIS SECTION. CHECK THE PROPER BOX ONLY. --> > > - [ ] `doc` <!-- Your PR contains doc changes --> > - [ ] `doc-required` <!-- Your PR changes impact docs and you will update later --> > - [ ] `doc-not-needed` <!-- Your PR changes do not impact docs --> > - [ ] `doc-complete` <!-- Docs have been already added --> > > > Document in the google doc: <!-- ENTER URL HERE --> > <!-- If your PR contains a lot of doc changes --> > > Website local preview <!-- ATTACH PREVIEW SCREENSHOTS --> > <!-- If your PR contains doc changes, you need to run `sh start.sh` at `$pwd`/site2/website and attach the preview screenshots here. --> > ``` Hi @liangyepianzhou thanks for your feedback! 1. Local preview screenshots When talking about "local preview screenshots", it refers to the "local preview screenshots" in https://github.com/apache/pulsar/pull/14314#issue-1139667381 rather than "preview screenshots" in https://github.com/apache/pulsar/pull/17853#issue-1387615390 2. Google docs Google docs is not a must for every doc PR. But if you working on a large doc set, to accelerate the review process and collaborate efficiently, it is recommended to follow the steps below: (1) Draft in a google doc (2) Request technical reviews and incorporate comments (3) Request technical writing reviews and incorporate comments (4) Send a PR, attach the google doc link (to show your writings have been reviewed by others) and local preview screenshots (to show everything goes fine) In this way, you can get PRs merged faster and more smoothly. cc @DaveDuggins @momo-jun @D-2-Ed 🔹🔹🔹 Besides, I've added a simple reminder to the PR template, https://github.com/apache/pulsar/pull/17999, PTAL @liangyepianzhou @tisonkun -- 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]
