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

Revise visualisation documentation for Plotly charts, Matplotlib #2061

Merged
merged 98 commits into from
Jan 4, 2023

Conversation

stichbury
Copy link
Contributor

@stichbury stichbury commented Nov 24, 2022

This PR is now ready for review.

Description

Resolves #1949

I've made some improvements to the docs for Kedro-Viz in the "Visualisation with Kedro-Viz" section:

  • Readability changes in the pages that introduce kedro viz and plotly reporting
  • Improvements to use the spaceflights starter (a recent change pulled it out of the main spaceflights tutorial, this was a tidy-up to explain how to use plotly reporting by adding it on top of the starter code)
  • Minor changes in experiment tracking, since that will be covered more comprehensively by a separate issue
  • New screen shots for plotly charts

You can see the files changed here: https://stichbury.github.io/

It's probably easier to review the built HTML instead of the diffs but any feedback would be appreciated. Since we released 18.4 i've tried to rebuild the example and now I cannot get the chart to show in viz. I've also updated my Mac OS to the latest version and I've no idea which of those changes (or something else) has broken the charts.

Tested on Chrome & Safari.

Checklist

  • Read the contributing guidelines
  • Opened this PR as a 'Draft Pull Request' if it is work-in-progress
  • Updated the documentation to reflect the code changes
  • Added a description of this change in the RELEASE.md file
  • Added tests to cover my changes

stichbury and others added 30 commits October 20, 2022 11:36
Mostly removing text and simplifying FTW

Signed-off-by: Jo Stichbury <[email protected]>
@stichbury stichbury marked this pull request as ready for review December 20, 2022 17:56
@stichbury stichbury requested a review from yetudada as a code owner December 20, 2022 17:56
@stichbury stichbury changed the title [DRAFT] Revise visualisation documentation for Plotly charts, Matplotlib and general Kedro-Viz docs improvements Revise visualisation documentation for Plotly charts, Matplotlib Dec 20, 2022
Copy link
Member

@merelcht merelcht left a comment

Choose a reason for hiding this comment

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

I like these improvements!

I just left a comment about the repeated node name for the compare_passenger_capacity function.

Copy link
Member

@merelcht merelcht left a comment

Choose a reason for hiding this comment

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

This looks great @stichbury ! And good thinking on adding a note about this working up to Kedro 0.18.3 👍

Copy link
Contributor

@rashidakanchwala rashidakanchwala left a comment

Choose a reason for hiding this comment

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

Look's great to me. thanks @stichbury

Copy link
Contributor

@yetudada yetudada left a comment

Choose a reason for hiding this comment

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

The revisions to this documentation are sorely needed! Thanks for leading this @stichbury! I've left some comments on structure, user-friendliness and minor formatting.

@stichbury stichbury merged commit 93255a3 into main Jan 4, 2023
@stichbury stichbury deleted the 1949-kedro-viz-docs-revision branch January 4, 2023 15:10
jmholzer pushed a commit that referenced this pull request Jan 9, 2023
Update the documentation about plotly charts and general intro to kedro viz. More to come on experiment tracking.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Component: Documentation 📄 Issue/PR for markdown and API documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Improve visualisation sections for the basics and for Plotly reporting
4 participants