Skip to content

docs: add juptyer API tutorial for API and jupyter tutorial index#3

Merged
317brian merged 12 commits into
api-tutorial-using-jupyterfrom
api-tutorial-jupyter-nb
Nov 9, 2022
Merged

docs: add juptyer API tutorial for API and jupyter tutorial index#3
317brian merged 12 commits into
api-tutorial-using-jupyterfrom
api-tutorial-jupyter-nb

Conversation

@317brian

@317brian 317brian commented Nov 1, 2022

Copy link
Copy Markdown
Owner
  • Adds an index page that links to the notebook. Index page includes prereqs for the notebooks
  • Updates gitignore so that checkpoint files are not added to GitHub
  • The notebook is stored in the assets folder. This shouldn't be an issue since it's not much bigger than a markdown file of equivalent length.

After this is reviewed/approved, I will make a commit that locks the markdown cells to be uneditable by default. (This is more a guardrail for accidents. Someone still could if they change the metadata).

@317brian
317brian marked this pull request as ready for review November 1, 2022 22:46

@techdocsmith techdocsmith left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Couple comments. But otherwise this is what I was thinking.


- An available Druid instance. You can use the `micro-quickstart` configuration described in [Quickstart (local)](./index.md). The tutorials assume that you are using the quickstart, so no authentication or authorization is expected unless explicitly mentioned.

- The `requests` package for Python. For example, you can install it with the following command:

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Python 3?

Comment thread docs/tutorials/jupyter-index.md Outdated
~ under the License.
-->

There are Jupyter notebook-based tutorials that are available for you to try as you learn more about Druid. These tutorials provide snippets of Python code that you can use to run calls against the Druid API.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
There are Jupyter notebook-based tutorials that are available for you to try as you learn more about Druid. These tutorials provide snippets of Python code that you can use to run calls against the Druid API.
There are Jupyter notebook-based tutorials that are available for you to try as you learn more about Druid. These tutorials provide snippets of Python code that you can use to run calls against the Druid API.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Something I don't like about "There are". What about: You can try out the APIs using the notebooks... or something.

@317brian
317brian changed the base branch from master to api-tutorial-using-jupyter November 9, 2022 23:00
@317brian
317brian merged commit aeb8d9e into api-tutorial-using-jupyter Nov 9, 2022
@317brian
317brian deleted the api-tutorial-jupyter-nb branch November 9, 2022 23:01
317brian added a commit that referenced this pull request Nov 9, 2022
317brian added a commit that referenced this pull request Feb 22, 2023
* docs: add juptyer API tutorial for API and jupyter tutorial index (#3)

(cherry picked from commit aeb8d9e)

* update prereqs and fix jupyterlab name

* Removing notebook since 13345 has it

13345 should be merged first

* update contributing instructions

* docs: link to the  Druid SQL tutorial

* Add link to partitioning

* fix merge conflict

* Saving

* Update docs/tutorials/tutorial-jupyter-index.md

* Remove partitioning

---------

Co-authored-by: 317brian <[email protected]>
Co-authored-by: brian.le <[email protected]>
Co-authored-by: Charles Smith <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants