diff --git a/README.md b/README.md index 4b78024eb4..d36ac4dd75 100644 --- a/README.md +++ b/README.md @@ -180,6 +180,7 @@ Options: --bucket-name TEXT Bucket name where Kedro Viz will be hosted [required] --include-hooks A flag to include all registered hooks in your Kedro Project + --include-previews A flag to include preview for all the datasets -h, --help Show this message and exit. ``` @@ -195,9 +196,10 @@ Usage: kedro viz build [OPTIONS] Create build directory of local Kedro Viz instance with Kedro project data Options: - --include-hooks A flag to include all registered hooks in your Kedro - Project - -h, --help Show this message and exit. + --include-hooks A flag to include all registered hooks in your Kedro + Project + --include-previews A flag to include preview for all the datasets + -h, --help Show this message and exit. ``` ### Experiment Tracking usage diff --git a/docs/source/images/kedro-publish-aws.gif b/docs/source/images/kedro-publish-aws.gif index b30fb2230b..cc3a9ab70c 100644 Binary files a/docs/source/images/kedro-publish-aws.gif and b/docs/source/images/kedro-publish-aws.gif differ diff --git a/docs/source/images/kedro-publish-azure.gif b/docs/source/images/kedro-publish-azure.gif index 87b9ee95c1..dd293d76cc 100644 Binary files a/docs/source/images/kedro-publish-azure.gif and b/docs/source/images/kedro-publish-azure.gif differ diff --git a/docs/source/images/kedro-publish-gcp.gif b/docs/source/images/kedro-publish-gcp.gif index a14ac55ac1..fc393afe48 100644 Binary files a/docs/source/images/kedro-publish-gcp.gif and b/docs/source/images/kedro-publish-gcp.gif differ diff --git a/docs/source/platform_agnostic_sharing_with_kedro_viz.md b/docs/source/platform_agnostic_sharing_with_kedro_viz.md index ec67ed1e6e..228e875d42 100644 --- a/docs/source/platform_agnostic_sharing_with_kedro_viz.md +++ b/docs/source/platform_agnostic_sharing_with_kedro_viz.md @@ -40,6 +40,10 @@ kedro>=0.18.2 kedro viz build ``` +```{note} +Starting from Kedro-Viz 9.2.0, `kedro viz build` will not include dataset previews by default. To enable previews for all the datasets, use the `--include-previews` flag. +``` + This creates a `build` folder containing your Kedro-Viz app package in your project directory. ## Static website hosting platforms such as GitHub Pages diff --git a/docs/source/preview_datasets.md b/docs/source/preview_datasets.md index 9a9962eeb7..474822e1f6 100644 --- a/docs/source/preview_datasets.md +++ b/docs/source/preview_datasets.md @@ -57,3 +57,6 @@ companies: preview: false ``` +```{note} +Starting from Kedro-Viz 9.2.0, previews are disabled by default for the CLI commands `kedro viz deploy` and `kedro viz build`. You can control this behavior using the `--include-previews` flag with these commands. For `kedro viz run`, previews are enabled by default and can be controlled from the publish modal dialog, refer to the [Publish and share](./share_kedro_viz) for more instructions. +``` \ No newline at end of file diff --git a/docs/source/publish_and_share_kedro_viz_on_aws.md b/docs/source/publish_and_share_kedro_viz_on_aws.md index 36a376e7c8..9dfb4a1c0c 100644 --- a/docs/source/publish_and_share_kedro_viz_on_aws.md +++ b/docs/source/publish_and_share_kedro_viz_on_aws.md @@ -83,6 +83,7 @@ Set up endpoint The endpoint link can be found under **S3 bucket -> Properties -> Static website hosting -> Bucket website endpoint**. ``` +Before publishing, you can enable or disable the preview for all datasets by toggling the "All dataset previews" button in the modal dialog. Once those details are complete, click **Publish**. A hosted, shareable URL will be returned to you after the process completes. ![](./images/kedro-publish-aws.gif) @@ -105,6 +106,10 @@ If you are on Kedro-Viz 7.0.0 you can still publish and share Kedro-Viz project kedro viz deploy --region=[aws-bucket-region] --bucket-name=[aws-bucket-name] ``` +```{note} +Starting from Kedro-Viz 9.2.0, `kedro viz deploy` will not include dataset previews by default. To enable previews for all the datasets, use the `--include-previews` flag. +``` + ## Permissions and access control Kedro-Viz does not manage permissions or access control. AWS manages all permissions and access control. As a user, you have the choice to allow anyone to view your project or restrict access to specific IP addresses, users, or groups. diff --git a/docs/source/publish_and_share_kedro_viz_on_azure.md b/docs/source/publish_and_share_kedro_viz_on_azure.md index 6deb690e55..3eb79348dd 100644 --- a/docs/source/publish_and_share_kedro_viz_on_azure.md +++ b/docs/source/publish_and_share_kedro_viz_on_azure.md @@ -103,6 +103,7 @@ Set up endpoint The endpoint link can be found under **Storage account -> Capabilities -> Static website -> Primary endpoint**. ``` +Before publishing, you can enable or disable the preview for all datasets by toggling the "All dataset previews" button in the modal dialog. Once those details are complete, click **Publish**. A hosted, shareable URL will be returned to you after the process completes. ![](./images/kedro-publish-azure.gif) @@ -115,6 +116,10 @@ Use the `kedro viz deploy` command to publish Kedro-Viz on Azure. You can execut kedro viz deploy --platform=azure --endpoint=[azure-endpoint] --bucket-name=[azure-bucket-name] ``` +```{note} +Starting from Kedro-Viz 9.2.0, `kedro viz deploy` will not include dataset previews by default. To enable previews for all the datasets, use the `--include-previews` flag. +``` + ## Permissions and access control Kedro-Viz does not manage permissions or access control. Azure manages all permissions and access control. As a user, you have the choice to allow anyone to view your project or restrict access to specific IP addresses, users, or groups. diff --git a/docs/source/publish_and_share_kedro_viz_on_gcp.md b/docs/source/publish_and_share_kedro_viz_on_gcp.md index c27a87ac6b..d054bbe414 100644 --- a/docs/source/publish_and_share_kedro_viz_on_gcp.md +++ b/docs/source/publish_and_share_kedro_viz_on_gcp.md @@ -89,6 +89,7 @@ The endpoint link can be found under your **Application Load Balancer -> Fronten If you have set up SSL certificate and serve your site using `HTTPS` then provide your root domain. ``` +Before publishing, you can enable or disable the preview for all datasets by toggling the "All dataset previews" button in the modal dialog. Once those details are complete, click **Publish**. A hosted, shareable URL will be returned to you after the process completes. ![](./images/kedro-publish-gcp.gif) @@ -101,6 +102,10 @@ Use the `kedro viz deploy` command to publish Kedro-Viz on GCP. You can execute kedro viz deploy --platform=gcp --endpoint=[gcp-endpoint] --bucket-name=[gcp-bucket-name] ``` +```{note} +Starting from Kedro-Viz 9.2.0, `kedro viz deploy` will not include dataset previews by default. To enable previews for all the datasets, use the `--include-previews` flag. +``` + ## Permissions and access control Kedro-Viz does not manage permissions or access control. GCP manages all permissions and access control. As a user, you have the choice to allow anyone to view your project or restrict access to specific IP addresses, users, or groups.