Skip to content

Add links to @willirath tutorial#290

Merged
willirath merged 5 commits into
dask:masterfrom
lesteve:add-willirath-tutorial
Jul 16, 2019
Merged

Add links to @willirath tutorial#290
willirath merged 5 commits into
dask:masterfrom
lesteve:add-willirath-tutorial

Conversation

@lesteve
Copy link
Copy Markdown
Member

@lesteve lesteve commented Jul 16, 2019

I added them on the docs and in the README. Any comments, let me know!

This is how it looks on the documentation generated locally:

image.

@lesteve
Copy link
Copy Markdown
Member Author

lesteve commented Jul 16, 2019

I wanted to say it is slightly weird to have the Tutorial non-section before the "Getting started" but I figure it is better to make the tutorial prominent rather than hidden in a sub-page.

Copy link
Copy Markdown
Member

@guillaumeeb guillaumeeb left a comment

Choose a reason for hiding this comment

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

This is a fantastic idea to promote @willirath's work and demonstrate dask-jobqueue use!

@willirath
Copy link
Copy Markdown
Collaborator

Thanks for adding these!

There's a DOI now: https://doi.org/10.5281/zenodo.3337784

But the look and feel is much nicer in the Github repo. So I'm not sure which to better include. The DOI is much more stable, though.

@willirath
Copy link
Copy Markdown
Collaborator

I wanted to say it is slightly weird to have the Tutorial non-section before the "Getting started" but I figure it is better to make the tutorial prominent rather than hidden in a sub-page.

What about putting it in a Tutorials page under "Detailed Use"? There, we could also link the video from the front page and the slides / video of @andersy005's SciPy2019 talk.

@lesteve
Copy link
Copy Markdown
Member Author

lesteve commented Jul 16, 2019

I haven't had time to catch up with SciPy I have to admit (just watching Matt's talk now). My not super strong opinions:

  • I'd be in favour to make the tutorial(s) prominent. So maybe a reasonable compromise is to have a link with tutorials on the main documentation page that goes to a "Tutorials" sub-section.
  • I'd go for the github repo rather than the DOI. user-friendly trumps stability in this particular case.

@willirath
Copy link
Copy Markdown
Collaborator

Sounds great!

@lesteve lesteve force-pushed the add-willirath-tutorial branch from d529eb2 to 569e5dc Compare July 16, 2019 15:09
@lesteve
Copy link
Copy Markdown
Member Author

lesteve commented Jul 16, 2019

Pushed an update. I put this in the "Getting started" section, because I feel this is where I would expect a tutorial to show up rather than "detailed use". Let me know what you think.

image

@willirath
Copy link
Copy Markdown
Collaborator

Looks great!

@willirath
Copy link
Copy Markdown
Collaborator

If there's no objections within the next hour or so, I'd merge.

@willirath willirath merged commit 299bc92 into dask:master Jul 16, 2019
@lesteve lesteve deleted the add-willirath-tutorial branch July 18, 2019 09:24
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.

3 participants