techdocsmith opened a new issue, #14901: URL: https://github.com/apache/druid/issues/14901
### Motivation The Druid docs have evolved with only a basic attention to documentation style. Some effort has been made to provide stylistic guidance in the documentation contribution guide: https://druid.apache.org/docs/latest/development/contribute-to-docs/ As the project matures, it makes sense to adopt a common style so that contributors have a common reference when composing and reviewing documentation. ### Proposed changes Rather than create a new style, I recommend we follow the Google Developer Documentation Style Guide: https://developers.google.com/style. Open to Where the Google Developer Documentation Style Guide is not consistent with the goals of the Apache Druid documentation, we document the exception for clarity. One such example would be to avoid code font for SQL syntax which can make the documentation more difficult to read. ### Rationale It is easier to adopt an existing style that aligns with the principal goals of the documentation (developer docs) rather than to attempt to create an exhaustive unique style ### Operational impact Improved reference when creating and reviewing documentation. ### Future work (optional) There will need to be ongoing maintenance of the style guide to keep it relevant. -- 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] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
