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

Rework the landing page and add a Getting started guide #838

Merged
merged 4 commits into from
Aug 25, 2022

Conversation

maximlt
Copy link
Member

@maximlt maximlt commented Aug 18, 2022

The landing page was basically a getting started guide which was a little difficult to extend to include .interactive and explorer. I've reworked it to (hopefully) make it look nicer and to include these two features. I've also added a Getting started guide that has 4 pages: Installation, .hvplot, .interactive and explorer. The page on .hvplot is basically the former landing page. The content on these pages could be improved (in a future iteration) but the scaffolding is now in place for this next step to be easier. Interestingly, .hvplot(), .interactive() and explorer are documented separately but I believe they could be combined in one story around data exploration. For this to happen some improvements to the Explorer would be required so that it supports more data structures.

I've added many screenshots and GIFs to support the landing page. I've tried to make them as light as possible, the total size is 3.9 MB. If it's too big, they will have to be hosted somewhere else. The advantage of having them in the repo is that the README could re-use them. Also I guess this would make it easier to set up docs versioning.

I'm going to build the docs based on this branch to see how this looks.

@MarcSkovMadsen
Copy link
Collaborator

MarcSkovMadsen commented Aug 19, 2022

If you want lighter videos use .mp4. There are options to auto run them.

But test on mobile+laptop and different browsers to find an exact set of settings that work and look nice in all places.

@MarcSkovMadsen
Copy link
Collaborator

Hi @maximlt

Is it possible to see the rendered result somewhere? That would make the review easier.

Copy link
Collaborator

@MarcSkovMadsen MarcSkovMadsen left a comment

Choose a reason for hiding this comment

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

The diagram.svg file could be simplified a bit one day. I think better alignment of objects and less arrows would make the figure easier to digest.

@MarcSkovMadsen
Copy link
Collaborator

The networkx colors also need an overhaul one day. The red and green dont go very well together. Makes it look very old and outdated.

@maximlt
Copy link
Member Author

maximlt commented Aug 22, 2022

Yep you can find a link to the dev docs on the README of every page of the HoloViz projects. This is the second badge on the third line.

image

Agreeing with both of your suggestions.

@maximlt maximlt merged commit 0cea6fc into master Aug 25, 2022
@maximlt maximlt deleted the rework_start_experience branch August 25, 2022 01:20
@MarcSkovMadsen
Copy link
Collaborator

Regarding the link to the "dev" docs. I guess they would be of the current master? I.e. not this branch before it was merged.

I.e. I could not use that link to help me review the PR @maximlt ?

@maximlt
Copy link
Member Author

maximlt commented Aug 25, 2022

Are you not clicking on the right link? When I access this URL I do see the landing page added by this PR: https://pyviz-dev.github.io/hvplot/

The docs are built and deployed in two ways:

  • on release, i.e. as soon as a new tag is pushed to the repo
  • thanks to Github workflow_dispatch events, that offer a small UI to parameterize and launch workflows. This is what I've used to build the docs from this PR (selection another branch than master)

image

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.

2 participants