Skip to content

Restructure documentation landing page#10519

Merged
pavithraes merged 7 commits intobranch-2.3from
timo/docs/landingpage
Sep 27, 2020
Merged

Restructure documentation landing page#10519
pavithraes merged 7 commits intobranch-2.3from
timo/docs/landingpage

Conversation

@tcmetzger
Copy link
Copy Markdown
Member

As part of Google's Season of Docs, this pull request restructures the landing page for Bokeh's documentation. As discussed with @bryevdv, @hyles-lineata, and @pavithraes.

@tcmetzger
Copy link
Copy Markdown
Member Author

Well, seems like the CI is not able to install the new Sphinx extension correctly: Could not import extension sphinx_panels (exception: No module named 'sphinx_panels') - even though the extension is included in environment.yml. @bryevdv, do you have an idea what is happening here - is this an issue of CI or an issue of installing the package in the environment?

@bryevdv
Copy link
Copy Markdown
Member

bryevdv commented Sep 23, 2020

@tcmetzger the CI build uses the env files in the ci directory. Specifically the docs build uses environment-test-3.7.yml but I would update all the test env files there.

@bryevdv
Copy link
Copy Markdown
Member

bryevdv commented Sep 23, 2020

Is there a way to change the sizing column breaks for the images?

Screen Shot 2020-09-23 at 1 19 14 PM

Screen Shot 2020-09-23 at 1 19 34 PM

@bryevdv
Copy link
Copy Markdown
Member

bryevdv commented Sep 23, 2020

Other comments:

  • really like the plain search bar up top 👍
  • I like the responsive mini-gallery at the bottom, assuming the sizing issues can be fixed, it adds a nice finish to the page
  • I l personally liked colors on the cards, did you decide against using them?
  • Do we actually need the big header that states "Bokeh Documentation" ? Actually thinking about it now it seems a bit redundant.

I definitely think we'll need to find something at the top too, maybe a single more abstracted hero image instead lots of tiles, e.g. But some kind of visual splash is routine (I would say expected) for plotting libraries

The project can work with chris on this or (I think) NF is also getting an in-house designer, which might be a possibility. But that's also outside he scope of GSoD so I think the task for now is just to decide and document what approach is best for us, so we can plan to integrate that smoothly later

@tcmetzger
Copy link
Copy Markdown
Member Author

@bryevdv Something seems to have gone wrong with my changes to the CSS - this is why the thumbnails look strange and why we lost the colors. All of these things work in my local environment, so I'll check what went wrong with my commits.

@mattpap mattpap added this to the 2.3 milestone Sep 23, 2020
@tcmetzger
Copy link
Copy Markdown
Member Author

tcmetzger commented Sep 23, 2020

The issues @bryevdv had with the CSS seem to be a local problem. Force reloading the page in the browser (Shift+reload or Ctrl+reload) seems to fix this. As far as I can tell, the CSS in this PR works as it should:
grafik

@pavithraes
Copy link
Copy Markdown
Member

The cards look super nice! Yayy! Thank you @tcmetzger ! ^>^

I see the mini gallery is hidden on small screens, maybe we can open an issue for any new contributor to take a look at it in the future. What do y'all think?

@pavithraes pavithraes merged commit 9af7dc9 into branch-2.3 Sep 27, 2020
@bryevdv bryevdv deleted the timo/docs/landingpage branch September 27, 2020 17:40
@tcmetzger
Copy link
Copy Markdown
Member Author

Thanks, @pavithraes! Yes, I could not get the boxes to behave properly on the smallest screens. I forgot to fix this in time, sorry about that. I just opened a new pull request on a new branch (#10532) to fix the CSS for this.

@github-actions
Copy link
Copy Markdown

This pull request has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Oct 27, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants