diff --git a/docs/tutorials/tutorial-jupyter-index.md b/docs/tutorials/tutorial-jupyter-index.md index 012bb7e16cd..c5b872fb431 100644 --- a/docs/tutorials/tutorial-jupyter-index.md +++ b/docs/tutorials/tutorial-jupyter-index.md @@ -36,7 +36,7 @@ Make sure you meet the following requirements before starting the Jupyter-based ```bash pip3 install requests - ``` + ```` - JupyterLab (recommended) or Jupyter Notebook running on a non-default port. By default, Druid and Jupyter both try to use port `8888,` so start Jupyter on a different port. @@ -48,17 +48,17 @@ Make sure you meet the following requirements before starting the Jupyter-based # Install Jupyter Notebook pip3 install notebook ``` - - Start Jupyter - - JupyterLab - ```bash - # Start JupyterLab on port 3001 - jupyter lab --port 3001 - ``` - - Jupyter Notebook - ```bash - # Start Jupyter Notebook on port 3001 - jupyter notebook --port 3001 - ``` + - Start JupyterLab + + ```bash + # Start JupyterLab on port 3001 + jupyter lab --port 3001 + ``` + - Alternatively, start Jupyter Notebook + ```bash + # Start Jupyter Notebook on port 3001 + jupyter notebook --port 3001 + ``` - An available Druid instance. You can use the [Quickstart (local)](./index.md) instance. The tutorials assume that you are using the quickstart, so no authentication or authorization is expected unless explicitly mentioned. @@ -68,4 +68,5 @@ The notebooks are located in the [apache/druid repo](https://github.com/apache/d The links that follow are the raw GitHub URLs, so you can use them to download the notebook directly, such as with `wget`, or manually through your web browser. Note that if you save the file from your web browser, make sure to remove the `.txt` extension. -- [Introduction to the Druid API](https://raw.githubusercontent.com/apache/druid/master/examples/quickstart/jupyter-notebooks/api-tutorial.ipynb) walks you through some of the basics related to the Druid API and several endpoints. \ No newline at end of file +- [Introduction to the Druid API](https://raw.githubusercontent.com/apache/druid/master/examples/quickstart/jupyter-notebooks/api-tutorial.ipynb) walks you through some of the basics related to the Druid API and several endpoints. +- [Introduction to Druid SQL](https://raw.githubusercontent.com/apache/druid/master/examples/quickstart/jupyter-notebooks/sql-tutorial.ipynb) covers the basics of Druid SQL. \ No newline at end of file diff --git a/examples/quickstart/jupyter-notebooks/README.md b/examples/quickstart/jupyter-notebooks/README.md index 7e5fa2becae..90c15f89ef1 100644 --- a/examples/quickstart/jupyter-notebooks/README.md +++ b/examples/quickstart/jupyter-notebooks/README.md @@ -45,6 +45,7 @@ Make sure you meet the following requirements before starting the Jupyter-based # Install Jupyter Notebook pip3 install notebook ``` + - Start Jupyter: - JupyterLab ```bash @@ -65,7 +66,8 @@ The notebooks are located in the [apache/druid repo](https://github.com/apache/d The links that follow are the raw GitHub URLs, so you can use them to download the notebook directly, such as with `wget`, or manually through your web browser. Note that if you save the file from your web browser, make sure to remove the `.txt` extension. -- [Introduction to the Druid API](api-tutorial.ipynb) walks you through some of the basics related to the Druid API and several endpoints. +- [Introduction to the Druid API](https://raw.githubusercontent.com/apache/druid/master/examples/quickstart/jupyter-notebooks/api-tutorial.ipynb) walks you through some of the basics related to the Druid API and several endpoints. +- [Introduction to Druid SQL](https://raw.githubusercontent.com/apache/druid/master/examples/quickstart/jupyter-notebooks/sql-tutorial.ipynb) covers the basics of Druid SQL. ## Contributing @@ -86,4 +88,4 @@ For the first PR, do the following: For the second PR, do the following: 1. Update the list of [Tutorials](#tutorials) on this page and in the [ Jupyter tutorial index page](../../../docs/tutorials/tutorial-jupyter-index.md#tutorials) in the `docs/tutorials` directory. -2. Update `tutorial-jupyter-index.md` and provide the URL to the raw version of the file that becomes available after the first PR is merged. +2. Update `tutorial-jupyter-index.md` and provide the URL to the raw version of the file that becomes available after the first PR is merged. \ No newline at end of file