Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update landing page #10674

Merged
merged 8 commits into from Dec 7, 2023
Merged

Update landing page #10674

merged 8 commits into from Dec 7, 2023

Conversation

mrocklin
Copy link
Member

@mrocklin mrocklin commented Dec 5, 2023

This rips out most of the previous content. It focuses less on Dask's internal design / intent / architecture / goals, and more on how to use the project.

I think (hope?) that the design also comes across a little more cleanly.

Screen.Recording.2023-12-05.at.1.08.19.PM.mov

cc @jrbourbeau @scharlottej13

This rips out most of the previous content.  It focuses less on Dask's
internal design / intent / architecture / goals, and more on how to use
the project.

I think (hope?) that the design also comes across a little more cleanly.
@mrocklin
Copy link
Member Author

mrocklin commented Dec 5, 2023

I've added a screen recording to the original comment so that people can get a sense for how it feels without building locally.

Copy link
Contributor

@scharlottej13 scharlottej13 left a comment

Choose a reason for hiding this comment

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

Thanks Matt, I like these changes overall (especially fewer words), and it's really nice to have the APIs higher up above the fold.


.. figure:: images/dask-overview.svg
Copy link
Contributor

Choose a reason for hiding this comment

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

I really like this figure, but probably introducing all of this on the docs homepage is not all that helpful. At quick glance it seems we also have it on 10 minutes to Dask and Scheduling, which are both a better fit.

Copy link
Member Author

Choose a reason for hiding this comment

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

Can you say more about what you like about it?

Copy link
Contributor

Choose a reason for hiding this comment

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

When I was newer to Dask I pretty much equated Dask with Dask DataFrame. Looking at this image helped orient me and answer questions like: how do all these collections fit together? what is "distributed"? why do I need to care about task graphs?

docs/source/index.rst Outdated Show resolved Hide resolved
docs/source/index.rst Outdated Show resolved Hide resolved
docs/source/index.rst Outdated Show resolved Hide resolved
docs/source/index.rst Outdated Show resolved Hide resolved
@@ -143,7 +315,7 @@ messy situations in everyday problems.
.. toctree::
:maxdepth: 1
:hidden:
:caption: Fundamentals
:caption: API
Copy link
Contributor

Choose a reason for hiding this comment

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

Maybe "Dask APIs"? Or something else to distinguish from the API reference lower down?

Copy link
Member Author

Choose a reason for hiding this comment

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

Hrm, I agree with the concern (mildly agree at least). I'm not a fan of this particular solution though.

Copy link
Member Author

Choose a reason for hiding this comment

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

I've made this "How to Use" for now

@github-actions github-actions bot added the documentation Improve or add to documentation label Dec 5, 2023
@mrocklin
Copy link
Member Author

mrocklin commented Dec 6, 2023

OK, I've given this a second pass. I think it's better than what we have today. I plan to merge tomorrow if there are no further comments.

@mrocklin mrocklin merged commit 191d391 into dask:main Dec 7, 2023
24 of 26 checks passed
@mrocklin mrocklin deleted the docs-landing branch December 7, 2023 17:32
@jrbourbeau jrbourbeau mentioned this pull request Dec 7, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improve or add to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants