You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@druid.apache.org by GitBox <gi...@apache.org> on 2022/08/02 11:01:58 UTC
[GitHub] [druid] petermarshallio opened a new pull request, #12850: Docs – README.md update around documentation contributions
petermarshallio opened a new pull request, #12850:
URL: https://github.com/apache/druid/pull/12850
Little expansion to encourage contribution to docs.
---
This PR has:
- [x] been self-reviewed.
--
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: commits-unsubscribe@druid.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@druid.apache.org
For additional commands, e-mail: commits-help@druid.apache.org
[GitHub] [druid] techdocsmith commented on a diff in pull request #12850: Docs – README.md update around documentation contributions
Posted by GitBox <gi...@apache.org>.
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: commits-unsubscribe@druid.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@druid.apache.org
For additional commands, e-mail: commits-help@druid.apache.org
[GitHub] [druid] paul-rogers commented on a diff in pull request #12850: Docs – README.md update around documentation contributions
Posted by GitBox <gi...@apache.org>.
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: commits-unsubscribe@druid.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@druid.apache.org
For additional commands, e-mail: commits-help@druid.apache.org
[GitHub] [druid] FrankChen021 commented on pull request #12850: Docs – README.md update around documentation contributions
Posted by GitBox <gi...@apache.org>.
FrankChen021 commented on PR #12850:
URL: https://github.com/apache/druid/pull/12850#issuecomment-1248843132
CI failed on ` (openjdk11) indexing modules test (SQL Compatibility)`
I think it has nothing to do with the changes in this PR.
--
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: commits-unsubscribe@druid.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@druid.apache.org
For additional commands, e-mail: commits-help@druid.apache.org
[GitHub] [druid] FrankChen021 merged pull request #12850: Docs – README.md update around documentation contributions
Posted by GitBox <gi...@apache.org>.
FrankChen021 merged PR #12850:
URL: https://github.com/apache/druid/pull/12850
--
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: commits-unsubscribe@druid.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@druid.apache.org
For additional commands, e-mail: commits-help@druid.apache.org
[GitHub] [druid] paul-rogers commented on pull request #12850: Docs – README.md update around documentation contributions
Posted by GitBox <gi...@apache.org>.
paul-rogers commented on PR #12850:
URL: https://github.com/apache/druid/pull/12850#issuecomment-1204163998
Found the file: `$DRUID_DEV/website/README.md`.
--
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: commits-unsubscribe@druid.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@druid.apache.org
For additional commands, e-mail: commits-help@druid.apache.org
[GitHub] [druid] petermarshallio commented on a diff in pull request #12850: Docs – README.md update around documentation contributions
Posted by GitBox <gi...@apache.org>.
petermarshallio commented on code in PR #12850:
URL: https://github.com/apache/druid/pull/12850#discussion_r936360895
##########
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:
Done :)
--
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: commits-unsubscribe@druid.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@druid.apache.org
For additional commands, e-mail: commits-help@druid.apache.org
[GitHub] [druid] techdocsmith commented on a diff in pull request #12850: Docs – README.md update around documentation contributions
Posted by GitBox <gi...@apache.org>.
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 noun: "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/
--
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: commits-unsubscribe@druid.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@druid.apache.org
For additional commands, e-mail: commits-help@druid.apache.org
[GitHub] [druid] petermarshallio commented on a diff in pull request #12850: Docs – README.md update around documentation contributions
Posted by GitBox <gi...@apache.org>.
petermarshallio commented on code in PR #12850:
URL: https://github.com/apache/druid/pull/12850#discussion_r936360895
##########
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:
Updated PR bit.
@paul-rogers I too thought that one day I found this... I tried to find it yesterday and couldn't track it down. Any ideas @techdocsmith ??!
--
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: commits-unsubscribe@druid.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@druid.apache.org
For additional commands, e-mail: commits-help@druid.apache.org
[GitHub] [druid] petermarshallio commented on pull request #12850: Docs – README.md update around documentation contributions
Posted by GitBox <gi...@apache.org>.
petermarshallio commented on PR #12850:
URL: https://github.com/apache/druid/pull/12850#issuecomment-1202340026
@techdocsmith I took the liberty. Is this OK?
--
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: commits-unsubscribe@druid.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@druid.apache.org
For additional commands, e-mail: commits-help@druid.apache.org