Update theme for rebranding

dask / dask-sphinx-theme

Sphinx theme for Dask documentation

BSD 3-Clause "New" or "Revised" License

6 stars 15 forks source link

Update theme for rebranding #67

Closed scharlottej13 closed 2 years ago

scharlottej13 commented 2 years ago

Update Dask docs design in line with rebranding efforts in https://github.com/dask/community/issues/220. Changes include updated Dask logo, color palettes, and fonts.

To do:

[ ] update icons
[ ] update syntax highlighting (see #69)
[ ] buttons for "next" and "previous" pages-- these look nice in the design doc, see Dask-Doc Portal Spec Sheet.pdf, but I'm not sure how to recreate them

Here are a couple screenshots for comparison:

current docs

changes in this PR Screen Shot 2022-05-31 at 10 49 45 PM

cc @jacobtomlinson @AdiReske @jrbourbeau @jsignell

AdiReske commented 2 years ago

Thank you!!

jsignell commented 2 years ago

Yeah I like that plan to merge and iterate. The docs won't be rebuilt until the next release unless we specifically trigger them in readthedocs.

scharlottej13 commented 2 years ago

Sounds good @jsignell and @jacobtomlinson, thanks for taking a look!

~Since @jrbourbeau fixed the RTD build, if you (or others) have bandwidth to click through some of the docs pages, that would be great. Of course, I can also make more changes after "going live" on 6/6.~ Sorry, realized that doesn't actually make sense!

scharlottej13 commented 2 years ago

The docs won't be rebuilt until the next release unless we specifically trigger them in readthedocs.

@jsignell does this mean triggering a docs build separately for each project (e.g. dask-ml, dask-distributed`, etc.)? And, if so, @jacobtomlinson does it make sense to merge these PRs today or tomorrow instead? I haven't triggered a rebuild in readthedocs before (I don't think I have permission to do so), but happy to do so if someone doesn't mind walking me through the steps.

cc @jrbourbeau

jacobtomlinson commented 2 years ago

Id rather wait until the website is live on Monday.

We need to merge here, tag a release, potential update pinned versions in downstream projects and then rebuild the docs sites on each of those.

In most cases rebuilding the downstream docs sites involves merging a PR to main.

scharlottej13 commented 2 years ago

We need to merge here, tag a release, potential update pinned versions in downstream projects and then rebuild the docs sites on each of those.

I can open up PRs to update the pinned versions in downstream projects. From the release history looks like it will be 2.0.4?

In most cases rebuilding the downstream docs sites involves merging a PR to main.

@jacobtomlinson would it be helpful for me to open placeholder PRs in downstream docs sites to make this easier? The downstream sites I have include (going down the list of repos):

[x] distributed
[x] dask-tutorial
[x] dask-kubernetes
[x] dask-cloudprovider
[x] dask-ml
[x] dask-gateway
[x] dask-examples
[x] dask-image
[x] dask-stories
[ ] dask-blog
[x] dask-mpi
[x] dask-jobqueue
[x] dask-yarn
[x] ? dask-glm

Also, thanks for answering all my questions! Just trying to figure out what the steps are and how I can help.

jacobtomlinson commented 2 years ago

That would be super helpful! Anything that's not marked as archived on GitHub will need updating.

I think given this is a major rebrand we should tag version 3.0.0 though.

scharlottej13 commented 2 years ago

That would be super helpful! Anything that's not marked as archived on GitHub will need updating.

I think given this is a major rebrand we should tag version 3.0.0 though.

Perfect! I'll open those PRs up today and will tag you two in them @jacobtomlinson and @jsignell