You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pulsar.apache.org by GitBox <gi...@apache.org> on 2019/06/20 07:11:27 UTC

[GitHub] [pulsar] Jennifer88huang opened a new pull request #4565: [docs] Add technical writing style for Pulsar docs to the site2/readme.md file

Jennifer88huang opened a new pull request #4565: [docs] Add technical writing style for Pulsar docs to the site2/readme.md file
URL: https://github.com/apache/pulsar/pull/4565
 
 
   ### Motivation
   When writing Pulsar docs, we can adopt a consistent writing styles, whoever the author is.
   Here I introduce [Google Developer Documentation Style Guide](https://developers.google.com/style/) for Pulsar technical docs. The style guide generally conforms to with most popular technical writing styles, such as *IBM style guides*, *Microsoft style guide*, *The Chicago Manual of Style*, and so on.
   In addition, *Google Developer Documentation Style Guide* is open to all, and the link is easy to share among all participants.
   
   ### Modifications
   1. Restructure the content of the site2/reademe file: website, doc, and translation.
   2. Introduce *Google Developer Documentation Style Guide* in **Contribute to documentation**.

----------------------------------------------------------------
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.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services