Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 11 commits into from
Dec 19, 2023
2 changes: 1 addition & 1 deletion docs/source/extend_kedro/common_use_cases.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion docs/source/get_started/new_project.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/`.
Expand Down
2 changes: 1 addition & 1 deletion docs/source/tutorial/add_another_pipeline.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand Down
2 changes: 1 addition & 1 deletion docs/source/tutorial/create_a_pipeline.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down