Change 'Kedro Viz' to 'Kedro Viz Run' (#3430)

* Update doc refs of 'kedro run' to 'kedro viz run' Signed-off-by: mehdinv <mehdinv@hotmail.com> * Update further references to be 'kedro viz run' Signed-off-by: mehdinv <mehdinv@hotmail.com> * Adjust doc files to use 'kedro viz run' instead Signed-off-by: Mehdi Naderi Varandi <MehdiNV@hotmail.com> * Adjust word to be 'hence', resolving warning Signed-off-by: Mehdi Naderi Varandi <MehdiNV@hotmail.com> * Update docs/source/extend_kedro/common_use_cases.md Co-authored-by: Jo Stichbury <jo_stichbury@mckinsey.com> Signed-off-by: Mehdi Naderi Varandi <MehdiNV@hotmail.com> --------- Signed-off-by: mehdinv <mehdinv@hotmail.com> Signed-off-by: Mehdi Naderi Varandi <MehdiNV@hotmail.com> Co-authored-by: Jo Stichbury <jo_stichbury@mckinsey.com>
kedro-org · Dec 19, 2023 · c30b94b · c30b94b
1 parent 4d77e19
commit c30b94b
Show file tree

Hide file tree

Showing 4 changed files with 4 additions and 4 deletions.
diff --git a/docs/source/extend_kedro/common_use_cases.md b/docs/source/extend_kedro/common_use_cases.md
@@ -31,7 +31,7 @@ def notebook_run(...):
     == ADD YOUR CUSTOM NOTEBOOK COMMAND CODE HERE ==
 ```
 
-To inject additional CLI commands intended to be reused across projects, see [our plugin system](./plugins.md). An example of one such command is the `kedro viz` command introduced by the [Kedro-Viz plugin](https://github.com/kedro-org/kedro-viz). This command is intended to work on every Kedro project and therefore must be a standalone plugin.
+To inject additional CLI commands intended to be reused across projects, see [our plugin system](./plugins.md). An example of one such command is the `kedro viz run` command introduced by the [Kedro-Viz plugin](https://github.com/kedro-org/kedro-viz). This command is intended to work on every Kedro project which is why it comes from a standalone plugin.
 
 ```{note}
 Your plugin's implementation can take advantage of other extension mechanisms such as Hooks.

diff --git a/docs/source/get_started/new_project.md b/docs/source/get_started/new_project.md
@@ -82,7 +82,7 @@ pip install kedro-viz
 To start Kedro-Viz, navigate to the project folder (`cd <project-name>`) and enter the following in your terminal:
 
 ```bash
-kedro viz
+kedro viz run
 ```
 
 This command automatically opens a browser tab to serve the visualisation at `http://127.0.0.1:4141/`.

diff --git a/docs/source/tutorial/add_another_pipeline.md b/docs/source/tutorial/add_another_pipeline.md
@@ -498,7 +498,7 @@ There are a separate set of parameters for `ds_pipeline_2` with the `candidate_m
 
 However, `model_input_table` does not get parameterised as it needs to be shared between instances, so is frozen outside the scope of the namespace wrappers.
 
-This renders as follows using `kedro viz` (hover over the datasets to see their full path) :
+This renders as follows using `kedro viz run` (hover over the datasets to see their full path) :
 
 ![modular_ds](../meta/images/modular_ds.gif)
 

diff --git a/docs/source/tutorial/create_a_pipeline.md b/docs/source/tutorial/create_a_pipeline.md
@@ -335,7 +335,7 @@ pip install kedro-viz
 To start Kedro-Viz, enter the following in your terminal:
 
 ```bash
-kedro viz
+kedro viz run
 ```
 
 This command automatically opens a browser tab to serve the visualisation at `http://127.0.0.1:4141/`. Explore the visualisation at leisure, and consult the {doc}`Kedro-Viz documentation<kedro-viz:kedro-viz_visualisation>` for more detail.