Anonymitaet commented on PR #544: URL: https://github.com/apache/pulsar-site/pull/544#issuecomment-1524712753
Hi @tpiperatgod, I submit this PR since it's more convenient to show you my thoughts and preview. ### Preview  ### Doc changes explanations 2️⃣3️⃣ in the image above I've restricted the doc structure by "showing the example first" and then "explaining the details". Reasons: 1) Most developers are likely "learning by doing" rather than "learning by reading". Examples always attract them the most. "Hook them up" first and then they have more patience to read it through. 2) The doc structure is more clear. The beginning is the example, and the latter is the explanation. Splitting them up can increase readability. 1️⃣ Consolidate the note into running text to accommodate the new structure. I've also made other changes like updating all future tense to present tense since "[Write in the simple present tense as much as possible if you are covering facts that were, are, and forever shall be true](https://docs.google.com/document/d/1lc5j4RtuLIzlEYCBo97AC8-U_3Erzs_lxpkDuseU0n4/edit#bookmark=id.e8uqh1awkcnp)" in technical writing. ### Question 4️⃣ Seems that the explanations in this box is contradictory. The above indicates "--config-file" override "command-line", but the below says the opposite. Can you clarify a bit and give some examples? Thank you! -- 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]
