docs: add index page and related stuff for jupyter tutorials#13342
Merged
vtlim merged 9 commits intoapache:masterfrom Dec 16, 2022
Merged
docs: add index page and related stuff for jupyter tutorials#13342vtlim merged 9 commits intoapache:masterfrom
vtlim merged 9 commits intoapache:masterfrom
Conversation
(cherry picked from commit aeb8d9e)
1 task
Contributor
Author
|
If we want to take the 2 PR approach, #13345 contains only the notebook file and .gitignore. If that one gets approved/merged, the download link in this one should work. |
13345 should be merged first
317brian
changed the title
vtlim
pushed a commit
to vtlim/druid
that referenced
this pull request
Dec 16, 2022
kfaraz
pushed a commit
that referenced
this pull request
Dec 17, 2022
* docs: add index page and related stuff for jupyter tutorials (#13342) * docs: notebook only for API tutorial (#13345) * docs: notebook for API tutorial * Apply suggestions from code review Co-authored-by: Charles Smith <techdocsmith@gmail.com> * address the other comments * typo * add commentary to outputs * address feedback from will * delete unnecessary comment Co-authored-by: Charles Smith <techdocsmith@gmail.com> Co-authored-by: 317brian <53799971+317brian@users.noreply.github.com> Co-authored-by: Charles Smith <techdocsmith@gmail.com>
This was referenced Dec 18, 2022
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
docs/tutorials/tutorial-jupyter-index.mdas a landing page for the Jupyter notebook tutorialssidebars.jsonto include the landing page.gitignoreto ignore the Jupyter checkpoint savestutorial-jupyter-index.mdas well as some basic info about contributingapi-tutorial.ipynbNote that the download links will 404 until this PR is merged into
mastersince they reference therawGitHub URL onmaster, which is the easiest way for a user to download a single notebook from what I found based on where we decided to put it.We can test the download link by either manually inserting a different file that already exists or splitting this PR into 2 and merging the notebook first. This is the link from it being merged into my fork
https://raw.githubusercontent.com/317brian/druid/master/examples/quickstart/jupyter-notebooks/api-tutorial.ipynbThis PR has: