vtlim commented on code in PR #14683:
URL: https://github.com/apache/druid/pull/14683#discussion_r1282247394
##########
examples/quickstart/jupyter-notebooks/notebooks/99-contributing/notebook-template.ipynb:
##########
@@ -35,37 +36,40 @@
"source": [
"## Prerequisites\n",
"\n",
- "This tutorial works with Druid XX.0.0 or later.\n",
+ "This tutorial works with Druid 26.0.0 or later.\n",
"\n",
- "Launch this tutorial and all prerequisites using the `all-services`
profile 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"
- ]
- },
- {
- "cell_type": "markdown",
- "id": "7ee6aef8-a11d-48d5-bcdc-e6231ba594b7",
- "metadata": {},
- "source": [
- "<details><summary> \n",
- "<b>Run without Docker Compose</b> \n",
- "</summary>\n",
+ "#### Run with Docker\n",
+ "\n",
+ "<!-- Profiles are:\n",
+ "`druid-jupyter` - just Jupyter and Druid\n",
+ "`all-services` - includes Jupyter, Druid, and Kafka\n",
+ " -->\n",
+ "\n",
+ "Launch this tutorial and all prerequisites using the ....... profile 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",
+ "#### Run without Docker\n",
"\n",
- "In order to run this notebook you will need:\n",
+ "If you do not use the Docker Compose environment, you need the
following:\n",
"\n",
- "<b>Required Services</b>\n",
- "* <!-- include list of components needed for notebook, i.e. kafka, druid
instance, etc. -->\n",
+ "* A running Apache Druid instance, with a `DRUID_HOST` local environment
variable containing the server name of your Druid router\n",
+ "*
[druidapi](https://github.com/apache/druid/blob/master/examples/quickstart/jupyter-notebooks/druidapi/README.md),
a Python client for Apache Druid. Follow the instructions in the Install
section of the README file.\n",
"\n",
- "<b>Python packages</b>\n",
- "* druidapi, a [Python client for Apache
Druid](https://github.com/apache/druid/blob/master/examples/quickstart/jupyter-notebooks/druidapi/README.md)\n",
- "* <!-- include any python package dependencies -->\n",
- "</details>"
+ " <!-- Remove as needed -->\n",
Review Comment:
This notation indicates a comment in HTML. Does it show up in Jupyter? In
GitHub, I just see something like a newline, but we should make sure anyone who
uses this template sees the note
##########
examples/quickstart/jupyter-notebooks/notebooks/99-contributing/notebook-template.ipynb:
##########
@@ -35,37 +36,40 @@
"source": [
"## Prerequisites\n",
"\n",
- "This tutorial works with Druid XX.0.0 or later.\n",
+ "This tutorial works with Druid 26.0.0 or later.\n",
Review Comment:
Just wondering why placeholder X got changed to 26? Seems like this should
be whatever the latest version is, or whatever the user tests with to build the
tutorial.
--
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]
