From e42152828d48211d0b9f1b2adbcdbb302d4ad6a9 Mon Sep 17 00:00:00 2001 From: rashidakanchwala Date: Mon, 4 Nov 2024 13:05:58 +0000 Subject: [PATCH 1/8] done Signed-off-by: rashidakanchwala --- docs/source/kedro-viz_visualisation.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/docs/source/kedro-viz_visualisation.md b/docs/source/kedro-viz_visualisation.md index db244697e..dadb263cc 100644 --- a/docs/source/kedro-viz_visualisation.md +++ b/docs/source/kedro-viz_visualisation.md @@ -196,21 +196,23 @@ The visualisation now includes the layers: ## Share a pipeline visualisation -You can share a pipeline structure within a Kedro-Viz visualisation as a JSON file from the terminal: +You can save a pipeline structure within a Kedro-Viz visualization directly from the terminal. ```bash kedro viz run --save-file=my_shareable_pipeline ``` -This command will save a visualisation of the `__default__` pipeline as a JSON file called `my_shareable_pipeline.json`. It doesn't share data, such as that in the code panel, nor can you share images or charts. +This command saves your visualization in a my_shareable_pipeline folder, which contains all pipeline and node information from your Kedro project. -To visualise the shared file, type the following to load it from the terminal: +To visualize your saved Kedro-Viz file, load it from the terminal with: ```bash kedro viz run --load-file=my_shareable_pipeline ``` +```{note} +This way of sharing requires a Kedro environment setup. -You can also share a complete project visualisation, described in more detail on [the following page](./share_kedro_viz). +For users who prefer not to set up a Kedro environment, Kedro-Viz visualizations can also be shared via multiple hosting solutions. More details are available on [the following page](./share_kedro_viz). ## Running Kedro-viz in a notebook. From 6b50fe859666c6b93a0c13fb1448f8160ee4bfba Mon Sep 17 00:00:00 2001 From: rashidakanchwala <37628668+rashidakanchwala@users.noreply.github.com> Date: Mon, 4 Nov 2024 13:07:58 +0000 Subject: [PATCH 2/8] Update kedro-viz_visualisation.md Signed-off-by: rashidakanchwala <37628668+rashidakanchwala@users.noreply.github.com> --- docs/source/kedro-viz_visualisation.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/kedro-viz_visualisation.md b/docs/source/kedro-viz_visualisation.md index dadb263cc..dc85cce2c 100644 --- a/docs/source/kedro-viz_visualisation.md +++ b/docs/source/kedro-viz_visualisation.md @@ -202,7 +202,7 @@ You can save a pipeline structure within a Kedro-Viz visualization directly from kedro viz run --save-file=my_shareable_pipeline ``` -This command saves your visualization in a my_shareable_pipeline folder, which contains all pipeline and node information from your Kedro project. +This command saves your visualization in a `my_shareable_pipeline` folder, which contains all pipeline and node information from your Kedro project. To visualize your saved Kedro-Viz file, load it from the terminal with: From fe27cfe16259fe6c3062f96fbc04bc90ef4f4e3b Mon Sep 17 00:00:00 2001 From: rashidakanchwala <37628668+rashidakanchwala@users.noreply.github.com> Date: Mon, 4 Nov 2024 13:14:24 +0000 Subject: [PATCH 3/8] Update kedro-viz_visualisation.md Signed-off-by: rashidakanchwala <37628668+rashidakanchwala@users.noreply.github.com> --- docs/source/kedro-viz_visualisation.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/source/kedro-viz_visualisation.md b/docs/source/kedro-viz_visualisation.md index dc85cce2c..2d756b266 100644 --- a/docs/source/kedro-viz_visualisation.md +++ b/docs/source/kedro-viz_visualisation.md @@ -196,15 +196,15 @@ The visualisation now includes the layers: ## Share a pipeline visualisation -You can save a pipeline structure within a Kedro-Viz visualization directly from the terminal. +You can save a pipeline structure within a Kedro-Viz visualisation directly from the terminal. ```bash kedro viz run --save-file=my_shareable_pipeline ``` -This command saves your visualization in a `my_shareable_pipeline` folder, which contains all pipeline and node information from your Kedro project. +This command saves your visualisation in a `my_shareable_pipeline` folder, which contains all pipeline and node information from your Kedro project. -To visualize your saved Kedro-Viz file, load it from the terminal with: +To visualise your saved Kedro-Viz file, load it from the terminal with: ```bash kedro viz run --load-file=my_shareable_pipeline @@ -212,7 +212,7 @@ kedro viz run --load-file=my_shareable_pipeline ```{note} This way of sharing requires a Kedro environment setup. -For users who prefer not to set up a Kedro environment, Kedro-Viz visualizations can also be shared via multiple hosting solutions. More details are available on [the following page](./share_kedro_viz). +For users who prefer not to set up a Kedro environment, Kedro-Viz visualisations can also be shared via multiple hosting solutions. More details are available on [the following page](./share_kedro_viz). ## Running Kedro-viz in a notebook. From 92806ca34d7c8ca30c5897390e0de70dea84ba30 Mon Sep 17 00:00:00 2001 From: rashidakanchwala <37628668+rashidakanchwala@users.noreply.github.com> Date: Mon, 4 Nov 2024 13:21:49 +0000 Subject: [PATCH 4/8] Update kedro-viz_visualisation.md Signed-off-by: rashidakanchwala <37628668+rashidakanchwala@users.noreply.github.com> --- docs/source/kedro-viz_visualisation.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/source/kedro-viz_visualisation.md b/docs/source/kedro-viz_visualisation.md index 2d756b266..086908a65 100644 --- a/docs/source/kedro-viz_visualisation.md +++ b/docs/source/kedro-viz_visualisation.md @@ -209,10 +209,12 @@ To visualise your saved Kedro-Viz file, load it from the terminal with: ```bash kedro viz run --load-file=my_shareable_pipeline ``` + ```{note} This way of sharing requires a Kedro environment setup. -For users who prefer not to set up a Kedro environment, Kedro-Viz visualisations can also be shared via multiple hosting solutions. More details are available on [the following page](./share_kedro_viz). +For users who prefer not to set up a Kedro environment, Kedro-Viz visualisations can also be shared via multiple hosting solutions. More details are available on [the following page](./share_kedro_viz). +``` ## Running Kedro-viz in a notebook. From 67bf8e2f5535816cca405edec35505b7d1e5997f Mon Sep 17 00:00:00 2001 From: rashidakanchwala <37628668+rashidakanchwala@users.noreply.github.com> Date: Mon, 4 Nov 2024 13:29:44 +0000 Subject: [PATCH 5/8] Update kedro-viz_visualisation.md Signed-off-by: rashidakanchwala <37628668+rashidakanchwala@users.noreply.github.com> --- docs/source/kedro-viz_visualisation.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/kedro-viz_visualisation.md b/docs/source/kedro-viz_visualisation.md index 086908a65..6c27e0705 100644 --- a/docs/source/kedro-viz_visualisation.md +++ b/docs/source/kedro-viz_visualisation.md @@ -204,7 +204,7 @@ kedro viz run --save-file=my_shareable_pipeline This command saves your visualisation in a `my_shareable_pipeline` folder, which contains all pipeline and node information from your Kedro project. -To visualise your saved Kedro-Viz file, load it from the terminal with: +To visualise your saved Kedro-Viz, load the `my_shareable_pipelin` folder from the terminal with: ```bash kedro viz run --load-file=my_shareable_pipeline From 89c218bd8dd99c4ba89cbc07cebc20d1b2678d7e Mon Sep 17 00:00:00 2001 From: rashidakanchwala <37628668+rashidakanchwala@users.noreply.github.com> Date: Mon, 4 Nov 2024 13:30:04 +0000 Subject: [PATCH 6/8] Update kedro-viz_visualisation.md Signed-off-by: rashidakanchwala <37628668+rashidakanchwala@users.noreply.github.com> --- docs/source/kedro-viz_visualisation.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/kedro-viz_visualisation.md b/docs/source/kedro-viz_visualisation.md index 6c27e0705..df8327b2d 100644 --- a/docs/source/kedro-viz_visualisation.md +++ b/docs/source/kedro-viz_visualisation.md @@ -204,7 +204,7 @@ kedro viz run --save-file=my_shareable_pipeline This command saves your visualisation in a `my_shareable_pipeline` folder, which contains all pipeline and node information from your Kedro project. -To visualise your saved Kedro-Viz, load the `my_shareable_pipelin` folder from the terminal with: +To visualise your saved Kedro-Viz, load the `my_shareable_pipeline` folder from the terminal with: ```bash kedro viz run --load-file=my_shareable_pipeline From 8710aedce2de1cdfda882573be19bb5dfaf98884 Mon Sep 17 00:00:00 2001 From: rashidakanchwala <37628668+rashidakanchwala@users.noreply.github.com> Date: Mon, 4 Nov 2024 13:56:16 +0000 Subject: [PATCH 7/8] Update docs/source/kedro-viz_visualisation.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Juan Luis Cano Rodríguez Signed-off-by: rashidakanchwala <37628668+rashidakanchwala@users.noreply.github.com> --- docs/source/kedro-viz_visualisation.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/kedro-viz_visualisation.md b/docs/source/kedro-viz_visualisation.md index df8327b2d..58c22cf52 100644 --- a/docs/source/kedro-viz_visualisation.md +++ b/docs/source/kedro-viz_visualisation.md @@ -213,7 +213,7 @@ kedro viz run --load-file=my_shareable_pipeline ```{note} This way of sharing requires a Kedro environment setup. -For users who prefer not to set up a Kedro environment, Kedro-Viz visualisations can also be shared via multiple hosting solutions. More details are available on [the following page](./share_kedro_viz). +For users who prefer not to set up a Kedro environment, [Kedro-Viz visualisations can also be shared via multiple hosting solutions](./share_kedro_viz). ``` ## Running Kedro-viz in a notebook. From e51709cffee4d1909934b870126420236e3ddb5c Mon Sep 17 00:00:00 2001 From: rashidakanchwala <37628668+rashidakanchwala@users.noreply.github.com> Date: Mon, 4 Nov 2024 13:56:23 +0000 Subject: [PATCH 8/8] Update docs/source/kedro-viz_visualisation.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Juan Luis Cano Rodríguez Signed-off-by: rashidakanchwala <37628668+rashidakanchwala@users.noreply.github.com> --- docs/source/kedro-viz_visualisation.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/kedro-viz_visualisation.md b/docs/source/kedro-viz_visualisation.md index 58c22cf52..04556d7e4 100644 --- a/docs/source/kedro-viz_visualisation.md +++ b/docs/source/kedro-viz_visualisation.md @@ -196,7 +196,7 @@ The visualisation now includes the layers: ## Share a pipeline visualisation -You can save a pipeline structure within a Kedro-Viz visualisation directly from the terminal. +You can save a pipeline structure within a Kedro-Viz visualisation directly from the terminal as follows: ```bash kedro viz run --save-file=my_shareable_pipeline