paul-rogers commented on code in PR #12850: URL: https://github.com/apache/druid/pull/12850#discussion_r936136496
########## README.md: ########## @@ -71,11 +71,9 @@ Use the built-in query workbench to prototype [DruidSQL](https://druid.apache.or ### Documentation -You can find the [documentation for the latest Druid release](https://druid.apache.org/docs/latest/) on -the [project website](https://druid.apache.org). +The [latest documentation](https://druid.apache.org/docs/latest/) is published with each official release to the [project website](https://druid.apache.org), where documentation for [previous releases](https://druid.apache.org/docs/) is also made available. -If you would like to contribute documentation, please do so under -`/docs` in this repository and submit a pull request. +Make documentation and tutorials updates in [`/docs`](https://github.com/apache/druid/tree/master/docs) using [MarkDown](https://www.markdownguide.org/) and contribute them using a Pull Request. Review Comment: Agreed, the usual term is "pull request" or "PR". I did a doc change way back when. I seem to recall there are instructions for how to set up the build system/checker/whatever we use. I seem to recall it will build the docs, complain about your boo-boos, and serve the results as a web page. We should link to that info (assuming I'm not imagining it) here. -- 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]
