vtlim commented on code in PR #14295:
URL: https://github.com/apache/druid/pull/14295#discussion_r1195801938
##########
examples/quickstart/jupyter-notebooks/Python_API_Tutorial.ipynb:
##########
@@ -28,6 +28,8 @@
"\n",
"This notebook provides a quick introduction to the Python wrapper around
the [Druid REST API](api-tutorial.ipynb). This notebook assumes you are
familiar with the basics of the REST API, and the [set of operations which
Druid
provides](https://druid.apache.org/docs/latest/operations/api-reference.html).
This tutorial focuses on using Python to access those APIs rather than
explaining the APIs themselves. The APIs themselves are covered in other
notebooks that use the Python API.\n",
"\n",
+ "This tutorial works with Druid 25.0.0 or later\n",
Review Comment:
```suggestion
"This tutorial works with Druid 25.0.0 or later.\n",
```
##########
examples/quickstart/jupyter-notebooks/Python_API_Tutorial.ipynb:
##########
@@ -58,6 +60,9 @@
"\n",
"The API uses the router to forward messages to each of Druid's services
so that you don't have to keep track of the host and port for each service.\n",
"\n",
+ "In the Docker Compose tutorial environment, the Router service runs at
\"http://router:8888\".\n";,
+ "If you are not using the Docker Compose environment, edit the URL for the
`jupyter_client`.\n",
Review Comment:
```suggestion
"If you are not using the Docker Compose environment, edit the URL for
the `jupyter_client`. For example, to `http://localhost:8888/`.\n";,
```
##########
examples/quickstart/jupyter-notebooks/kafka-tutorial.ipynb:
##########
@@ -50,6 +50,8 @@
"source": [
"## Prerequisites\n",
"\n",
+ "This tutorial works with Druid 25.0.0 or later\n",
Review Comment:
```suggestion
"This tutorial works with Druid 25.0.0 or later.\n",
```
##########
examples/quickstart/jupyter-notebooks/sql-tutorial.ipynb:
##########
@@ -46,15 +46,20 @@
"source": [
"## Prerequisites\n",
"\n",
- "Make sure that you meet the requirements outlined in the README.md file
of the [apache/druid
repo](https://github.com/apache/druid/tree/master/examples/quickstart/jupyter-notebooks/).\n",
- "Specifically, you need the following:\n",
- "- Knowledge of SQL\n",
- "- [Python3](https://www.python.org/downloads/)\n",
- "- The [`requests`
package](https://requests.readthedocs.io/en/latest/user/install/) for Python\n",
- "- [JupyterLab](https://jupyter.org/install#jupyterlab) (recommended) or
[Jupyter Notebook](https://jupyter.org/install#jupyter-notebook) running on a
non-default port. Druid and Jupyter both default to port `8888`, so you need to
start Jupyter on a different port. \n",
- "- An available Druid instance. This tutorial uses the automatic
single-machine configuration described in the [Druid
quickstart](https://druid.apache.org/docs/latest/tutorials/index.html), so no
authentication or authorization is required unless explicitly mentioned. If you
haven’t already, download Druid version 25.0 or higher and start Druid services
as described in the quickstart.\n",
+ "This tutorial works with Druid 25.0.0 or later\n",
Review Comment:
```suggestion
"This tutorial works with Druid 25.0.0 or later.\n",
```
##########
examples/quickstart/jupyter-notebooks/sql-tutorial.ipynb:
##########
@@ -46,15 +46,20 @@
"source": [
"## Prerequisites\n",
"\n",
- "Make sure that you meet the requirements outlined in the README.md file
of the [apache/druid
repo](https://github.com/apache/druid/tree/master/examples/quickstart/jupyter-notebooks/).\n",
- "Specifically, you need the following:\n",
- "- Knowledge of SQL\n",
- "- [Python3](https://www.python.org/downloads/)\n",
- "- The [`requests`
package](https://requests.readthedocs.io/en/latest/user/install/) for Python\n",
- "- [JupyterLab](https://jupyter.org/install#jupyterlab) (recommended) or
[Jupyter Notebook](https://jupyter.org/install#jupyter-notebook) running on a
non-default port. Druid and Jupyter both default to port `8888`, so you need to
start Jupyter on a different port. \n",
- "- An available Druid instance. This tutorial uses the automatic
single-machine configuration described in the [Druid
quickstart](https://druid.apache.org/docs/latest/tutorials/index.html), so no
authentication or authorization is required unless explicitly mentioned. If you
haven’t already, download Druid version 25.0 or higher and start Druid services
as described in the quickstart.\n",
+ "This tutorial works with Druid 25.0.0 or later\n",
+ "\n",
+ "Launch this tutorial and all prerequisites using the `druid-jupyter` or
`all-services` profiles of the Docker Compose file for Jupyter-based Druid
tutorials. For more information, see [Docker for Jupyter Notebook
tutorials](https://druid.apache.org/docs/latest/tutorials/tutorial-jupyter-docker.html).\n",
+ "\n",
+ "Otherwise, you need the following:\n",
+ "* A running Druid instance.<br>\n",
+ " Update the `druid_host` variable to point to your Router endpoint.
For example:\n",
+ " ```\n",
+ " druid_host = \"http://localhost:8888\"\n";,
+ " ```\n",
+ "* The [Druid Python API](Python_API_Tutorial.ipynb) to simplify access to
Druid.\n",
Review Comment:
Not sure if relative links work from Jupyter notebooks
```suggestion
"* The [Druid Python
API](https://github.com/apache/druid/blob/master/examples/quickstart/jupyter-notebooks/Python_API_Tutorial.ipynb)
to simplify access to Druid.\n",
```
##########
examples/quickstart/jupyter-notebooks/api-tutorial.ipynb:
##########
@@ -60,28 +60,18 @@
"source": [
"## Prerequisites\n",
"\n",
- "Install the [Requests](https://requests.readthedocs.io/en/latest/)
library for Python before you start. For example:\n",
+ "This tutorial works with Druid 25.0.0 or later\n",
Review Comment:
```suggestion
"This tutorial works with Druid 25.0.0 or later.\n",
```
--
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]
