Begin tutorial blog post #591
Draft
Conversation
This file contains 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
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
|
Could we perhaps revive this idea for SciPy 2024? 😁 The tutorial site still doesn't get the fanfare it deserves! |
|
We should publish it before that. Mind pushing some text? |
|
@scottyhq @JessicaS11 shall we try and finish this and use it to advertise the upcoming tutorial? |
|
Sorry to let this stagnate for so long. I'll take a pass today or tomorrow |
for more information, see https://pre-commit.ci
TomNicholas
reviewed
May 28, 2024
|
|
||
| We've been particularly happy with the [`jupyterlab-myst`](https://github.com/executablebooks/jupyterlab-myst) extension, which extends the basic Markdown rendering with in JupyterLab and ensures Notebooks rendered as a static webpage look identical to an exectuable notebook in the JupyterLab interface. | ||
|
|
||
| Finally, we think the Xarray Tutorial is a great way to engage new contributors to Open Source Sofware Development. Every Jupyterbook webpage has a GitHub icon dropdown in the upper right hand corner with a 'Open Issue' and 'Suggest Edit' button. This really simplifies the process of community development and we love that during workshops people totally new to the library have made improvements to the content as we run through it. The repository now has over 30 contributors! |
TomNicholas
reviewed
May 28, 2024
|
|
||
| - Data structures, indexing, alignment & broadcasting | ||
|
|
||
| 1. All New Intermediate level material |
There was a problem hiding this comment.
Suggested change
| 1. All New Intermediate level material | |
| 2. All New Intermediate level material |
dcherian
commented
May 28, 2024
|
|
||
| ## Redesigned with Jupyterbook | ||
|
|
||
| We chose to use [Jupyterbook](https://jupyterbook.org/en/stable/intro.html) as a the tool to render a static HTML version of the tutorial website. We think this has worked well, because it allows you to keep small Jupyter Notebooks in a repository while guaranteeing that code in those notebooks can be exectuded without errors. It also provides nice linking capabilities directly to the Xarray API documentation. Finally, Jupyterbook simply produces a nice-looking, navigable, and searchable website of all the material. See the before/after image: |
There was a problem hiding this comment.
Suggested change
| We chose to use [Jupyterbook](https://jupyterbook.org/en/stable/intro.html) as a the tool to render a static HTML version of the tutorial website. We think this has worked well, because it allows you to keep small Jupyter Notebooks in a repository while guaranteeing that code in those notebooks can be exectuded without errors. It also provides nice linking capabilities directly to the Xarray API documentation. Finally, Jupyterbook simply produces a nice-looking, navigable, and searchable website of all the material. See the before/after image: | |
| We chose to use [Jupyterbook](https://jupyterbook.org/en/stable/intro.html) as a the tool to render a static HTML version of the tutorial website. We think this has worked well, because it allows you to keep small Jupyter Notebooks in a repository while guaranteeing that code in those notebooks can be executed without errors. It also provides nice linking capabilities directly to the Xarray API documentation. Finally, Jupyterbook simply produces a nice-looking, navigable, and searchable website of all the material. See the before/after image: |
|
|
||
| We've been particularly happy with the [`jupyterlab-myst`](https://github.com/executablebooks/jupyterlab-myst) extension, which extends the basic Markdown rendering with in JupyterLab and ensures Notebooks rendered as a static webpage look identical to an exectuable notebook in the JupyterLab interface. | ||
|
|
||
| Finally, we think the Xarray Tutorial is a great way to engage new contributors to Open Source Sofware Development. Every Jupyterbook webpage has a GitHub icon dropdown in the upper right hand corner with a 'Open Issue' and 'Suggest Edit' button. This really simplifies the process of community development and we love that during workshops people totally new to the library have made improvements to the content as we run through it. The repository now has over 30 contributors! |
There was a problem hiding this comment.
Suggested change
| Finally, we think the Xarray Tutorial is a great way to engage new contributors to Open Source Sofware Development. Every Jupyterbook webpage has a GitHub icon dropdown in the upper right hand corner with a 'Open Issue' and 'Suggest Edit' button. This really simplifies the process of community development and we love that during workshops people totally new to the library have made improvements to the content as we run through it. The repository now has over 30 contributors! | |
| Finally, we think the Xarray Tutorial is a great way to engage new contributors to Open Source Software Development. Every Jupyterbook webpage has a GitHub icon dropdown in the upper right hand corner with a 'Open Issue' and 'Suggest Edit' button. This really simplifies the process of community development and we love that during workshops people totally new to the library have made improvements to the content as we run through it. The repository now has over 30 contributors! |
|
|
||
| We reworked existing material to bite-sized chunks that can be remixed as needed. For example, rather than organizing material by specific workshops at a top-level, we now organize by topic and then build a learning path for each event. This way future learners can benefit from a guided tour through the material. | ||
| For example see the [Fundamental](https://tutorial.xarray.dev/overview/fundamental-path/README.html) and [Intermediate](https://tutorial.xarray.dev/overview/intermediate-path/README.html) learning paths that were presented at SciPy 2022 and SciPy 2023 respectively. | ||
|
|
There was a problem hiding this comment.
Suggested change
| We believe this method of organizing material also lends it self to easy reuse for other tutorial/workshop activities that may not want to work through material in the manner the canonical ordering does. |
or something like that?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
@scottyhq @JessicaS11
I got started on an outline for a blogpost about the upgrades to the Xarray tutorial website. You should have rights to just push to the branch.