Skip to content

Commit

Permalink
Disable preview docs
Browse files Browse the repository at this point in the history
Signed-off-by: Jitendra Gundaniya <[email protected]>
  • Loading branch information
jitu5 committed May 23, 2024
1 parent 3132840 commit 766abe7
Show file tree
Hide file tree
Showing 6 changed files with 24 additions and 2 deletions.
4 changes: 4 additions & 0 deletions docs/source/platform_agnostic_sharing_with_kedro_viz.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,10 @@ kedro>=0.18.2
kedro viz build
```

```{note}
Starting from Kedro-Viz 9.1.0, previews are disabled by default for `kedro viz build`. To enable previews for all nodes of the datasets, use the `--include-preview` flag.
```

This creates a `build` folder containing your Kedro-Viz app package in your project directory.

## Static website hosting platforms such as GitHub Pages
Expand Down
3 changes: 3 additions & 0 deletions docs/source/preview_datasets.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,3 +57,6 @@ companies:
preview: false
```
```{note}
Starting from Kedro-Viz 9.1.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-preview` 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.
```
5 changes: 5 additions & 0 deletions docs/source/publish_and_share_kedro_viz_on_aws.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand All @@ -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.1.0, previews are disabled by default for `kedro viz deploy`. To enable previews for all nodes of the datasets, use the `--include-preview` 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.
Expand Down
5 changes: 5 additions & 0 deletions docs/source/publish_and_share_kedro_viz_on_azure.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand All @@ -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.1.0, previews are disabled by default for `kedro viz deploy`. To enable previews for all nodes of the datasets, use the `--include-preview` 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.
Expand Down
5 changes: 5 additions & 0 deletions docs/source/publish_and_share_kedro_viz_on_gcp.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand All @@ -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.1.0, previews are disabled by default for `kedro viz deploy`. To enable previews for all nodes of the datasets, use the `--include-preview` 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.
Expand Down
4 changes: 2 additions & 2 deletions package/tests/test_models/test_flowchart.py
Original file line number Diff line number Diff line change
Expand Up @@ -386,13 +386,13 @@ def test_get_preview_args(self):
)
assert data_node.get_preview_args() == {"nrows": 3}

def test_is_preview_disabled(self):
def test_is_preview_enabled(self):
metadata = {"kedro-viz": {"preview": False}}
dataset = CSVDataset(filepath="test.csv", metadata=metadata)
data_node = GraphNode.create_data_node(
dataset_name="dataset", tags=set(), layer=None, dataset=dataset, stats=None
)
assert data_node.is_preview_disabled() is True
assert data_node.is_preview_enabled() is False

def test_preview_data_node_metadata(self, example_data_node):
expected_preview_data = {
Expand Down

0 comments on commit 766abe7

Please sign in to comment.