Skip to content

Commit

Permalink
review suggestion.
Browse files Browse the repository at this point in the history
Signed-off-by: Jitendra Gundaniya <[email protected]>
  • Loading branch information
jitu5 committed Oct 10, 2024
1 parent 5e249ae commit cf5256d
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions docs/source/platform_agnostic_sharing_with_kedro_viz.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,9 +48,8 @@ This creates a `build` folder containing your Kedro-Viz app package in your proj

## Running Kedro-Viz Locally

Check warning on line 49 in docs/source/platform_agnostic_sharing_with_kedro_viz.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/source/platform_agnostic_sharing_with_kedro_viz.md#L49

[Kedro-viz.headings] 'Running Kedro-Viz Locally' should use sentence-style capitalization.
Raw output
{"message": "[Kedro-viz.headings] 'Running Kedro-Viz Locally' should use sentence-style capitalization.", "location": {"path": "docs/source/platform_agnostic_sharing_with_kedro_viz.md", "range": {"start": {"line": 49, "column": 4}}}, "severity": "WARNING"}

When you generate the build folder using the command `kedro viz build`, it creates a build directory with an `index.html` file, which serves as the entry point for visualizing your pipeline. However, simply opening `index.html` using the `file://` protocol is not supported due to Cross-Origin Resource Sharing (CORS) policies in modern browsers.
When you generate the build folder using the command `kedro viz build`, it creates a build directory with an `index.html` file, which serves as the entry point for visualizing your pipeline.

Check warning on line 51 in docs/source/platform_agnostic_sharing_with_kedro_viz.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/source/platform_agnostic_sharing_with_kedro_viz.md#L51

[Kedro-viz.ukspelling] In general, use UK English spelling instead of 'visualizing'.
Raw output
{"message": "[Kedro-viz.ukspelling] In general, use UK English spelling instead of 'visualizing'.", "location": {"path": "docs/source/platform_agnostic_sharing_with_kedro_viz.md", "range": {"start": {"line": 51, "column": 165}}}, "severity": "WARNING"}

### Using a Local Server

To view your pipeline visualization correctly, you need to serve `index.html` using an HTTP server. Here are a few simple ways to do this:

Check warning on line 54 in docs/source/platform_agnostic_sharing_with_kedro_viz.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/source/platform_agnostic_sharing_with_kedro_viz.md#L54

[Kedro-viz.ukspelling] In general, use UK English spelling instead of 'visualization'.
Raw output
{"message": "[Kedro-viz.ukspelling] In general, use UK English spelling instead of 'visualization'.", "location": {"path": "docs/source/platform_agnostic_sharing_with_kedro_viz.md", "range": {"start": {"line": 54, "column": 23}}}, "severity": "WARNING"}

Check warning on line 54 in docs/source/platform_agnostic_sharing_with_kedro_viz.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/source/platform_agnostic_sharing_with_kedro_viz.md#L54

[Kedro-viz.weaselwords] 'correctly' is a weasel word!
Raw output
{"message": "[Kedro-viz.weaselwords] 'correctly' is a weasel word!", "location": {"path": "docs/source/platform_agnostic_sharing_with_kedro_viz.md", "range": {"start": {"line": 54, "column": 37}}}, "severity": "WARNING"}

Check warning on line 54 in docs/source/platform_agnostic_sharing_with_kedro_viz.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/source/platform_agnostic_sharing_with_kedro_viz.md#L54

[Kedro-viz.weaselwords] 'few' is a weasel word!
Raw output
{"message": "[Kedro-viz.weaselwords] 'few' is a weasel word!", "location": {"path": "docs/source/platform_agnostic_sharing_with_kedro_viz.md", "range": {"start": {"line": 54, "column": 112}}}, "severity": "WARNING"}

Check warning on line 54 in docs/source/platform_agnostic_sharing_with_kedro_viz.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/source/platform_agnostic_sharing_with_kedro_viz.md#L54

[Kedro-viz.words] Use '' instead of 'simple'.
Raw output
{"message": "[Kedro-viz.words] Use '' instead of 'simple'.", "location": {"path": "docs/source/platform_agnostic_sharing_with_kedro_viz.md", "range": {"start": {"line": 54, "column": 116}}}, "severity": "WARNING"}

Expand All @@ -71,6 +70,9 @@ To view your pipeline visualization correctly, you need to serve `index.html` us
http-server
```
```{warning}
Simply opening `index.html` using the `file://` protocol is not supported due to Cross-Origin Resource Sharing (CORS) policies in modern browsers.
```
## Static website hosting platforms such as GitHub Pages
Expand Down

0 comments on commit cf5256d

Please sign in to comment.