Enable users to disable preview for all when publishing Kedro-Viz

kedro-org / kedro-viz

Visualise your Kedro data and machine-learning pipelines and track your experiments.

https://demo.kedro.org

Apache License 2.0

646 stars 106 forks source link

Enable users to disable preview for all when publishing Kedro-Viz #1870

Closed ravi-kumar-pilla closed 1 month ago

ravi-kumar-pilla commented 2 months ago

Description

This would help users to enable/disable preview for all the datasets.

Context

Users would like to have preview enabled in the catalog or for kedro viz run locally, but would like to disable the preview for all the datasets when deploying to cloud providers

https://kedro-org.slack.com/archives/C03RKP2LW64/p1713469330441069

Possible Implementation

Introduce a --include-preview option for all kedro viz cli commands
Default the preview feature to False (need to be discussed)

Possible Alternatives

Checklist

[x] Include labels so that we can categorise your feature request

rashidakanchwala commented 2 months ago

had a Design PS session with @stephkaiser , @idanov, @yetudada and @iamelijahko . The following came out of discussion

Instead of using --include-preview or --exclude-preview, we'll switch to --preview=false/true.
By default,kedro viz deploy and kedro viz build will set --preview=false.
On the other hand, kedro viz and kedro viz run will set --preview=true by default to ensure easy discovery of the feature.
In the UI, users will specify whether they want to Enable or Disable preview before publishing. The backend will then create a JSON API both either with or without preview data based on the user's selection that will get pushed to cloud

stephkaiser commented 2 months ago

Designs can be found here - https://www.figma.com/file/3kSpvIO1veLKfy9qHxuXwF/Kedro-WIP?type=design&node-id=1411-87299&mode=design&t=HEcOS0koRJ2SVfbX-4

ravi-kumar-pilla commented 1 month ago

Hi Team,

Based on our discussions, This ticket will focus on enabling/disabling preview for all the datasets during publishing.

Publishing from CLI - Preview will be disabled by default. If the users want to have preview, they should run -

kedro viz build --include-preview for platform agnostic build kedro viz deploy --include-preview for deploying viz instance on cloud

Publishing from UI - Preview will be enabled by default on local instance of kedro viz when someone runs kedro viz run. Now the users will have the preview enable/disable toggle on the publish pop-up through which they can control the deployable instance preview settings.

NOTE: kedro viz run will not have any flag to enable/disable preview. We will have a ticket in future where we can have preview enable/disable for local instance in settings panel of UI.

Thank you