techdocsmith commented on code in PR #12850: URL: https://github.com/apache/druid/pull/12850#discussion_r935791543
########## 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: I think pull request is not a proper now: "pull request" Also, since we don't currently have a guide for docs contributors, maybe we can say that they should read the Contributing section of the Community guide https://druid.apache.org/community/ ########## 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. Review Comment: ```suggestion See the [latest documentation](https://druid.apache.org/docs/latest/) for the documentation for the current official release. If you need information on a previous release, you can browse [previous releases documentation](https://druid.apache.org/docs/). ``` Avoid passive ########## README.md: ########## @@ -29,7 +29,7 @@ --- [Website](https://druid.apache.org/) | -[Documentation](https://druid.apache.org/docs/latest/design/) | +[Documentation](#documentation) | Review Comment: It looks like the intention of this link is to point to the documentation like the others in this section. Suggest leaving as-is. -- 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]
