From 2eb18d97f010025d16a0bba741a0b162afeeec39 Mon Sep 17 00:00:00 2001
From: rashidakanchwala <37628668+rashidakanchwala@users.noreply.github.com>
Date: Mon, 14 Oct 2024 12:09:17 +0100
Subject: [PATCH] Document python version policies and other small doc updates.
  (#2139)

---
 docs/source/kedro-viz_visualisation.md | 34 +++++++++++++++++---------
 package/README.md                      | 11 ++++-----
 2 files changed, 27 insertions(+), 18 deletions(-)

diff --git a/docs/source/kedro-viz_visualisation.md b/docs/source/kedro-viz_visualisation.md
index b650d32f0..db244697e 100644
--- a/docs/source/kedro-viz_visualisation.md
+++ b/docs/source/kedro-viz_visualisation.md
@@ -9,6 +9,16 @@ If you haven't installed Kedro {doc}`follow the documentation to get set up<kedr
 We recommend that you use the same version of Kedro that was most recently used to test this tutorial (0.19.0). To check the version installed, type `kedro -V` in your terminal window.
 ```
 
+Once you have installed Kedro, you can install Kedro-viz
+
+```bash
+pip install kedro-viz
+```
+
+```{note}
+[Kedro Viz](https://github.com/kedro-org/kedro-viz) supports all Python versions that are actively maintained by the CPython core team. When a [Python version reaches end of life](https://devguide.python.org/versions/#versions), support for that version is dropped from Kedro-viz. This is not considered a breaking change.
+```
+
 In your terminal window, navigate to the folder you want to store the project. Generate the spaceflights tutorial project with all the code in place by using the [Kedro starter for the spaceflights tutorial](https://github.com/kedro-org/kedro-starters/tree/main/spaceflights-pandas):
 
 
@@ -29,15 +39,6 @@ The next step is optional, but useful to check that all is working. Run the full
 ```bash
 kedro run
 ```
-Kedro-Viz provides stats related to datasets under the metadata panel
-
-![](./images/pipeline_dataset_stats.png)
-
-These stats are generated by hooks. If you have Kedro-Viz installed and execute `kedro run`, the hooks will generate the stats by default. To disable this, you can disable Kedro-Viz hooks in the settings file of your project.
-
-```{note}
-Starting from Kedro-Viz 9.2.0, the dataset stats file `stats.json` will be moved to `.viz` directory at the root of your Kedro project in-case you have `kedro-viz` installed and had not disabled hooks for `kedro-viz` plugin.
-```
 
 To start Kedro-Viz, type the following into your terminal from the project directory:
 
@@ -45,9 +46,8 @@ To start Kedro-Viz, type the following into your terminal from the project direc
 kedro viz run
 ```
 
-```{important}
-The former `kedro viz` command used here is now deprecated with the release of Kedro-Viz 7.0.0. 
-`kedro viz run` is now the new way to run the tool.
+```{note}
+You can also type `kedro viz` to start Kedro-viz
 ```
 
 The command opens a browser tab to serve the visualisation at `http://127.0.0.1:4141/`.
@@ -63,6 +63,16 @@ If a visualisation panel opens up and a pipeline is not visible, refresh the vie
 
 To exit the visualisation, close the browser tab. To regain control of the terminal, enter `^+c` on Mac or `Ctrl+c` on Windows or Linux machines.
 
+Kedro-Viz provides stats related to datasets under the metadata panel
+
+![](./images/pipeline_dataset_stats.png)
+
+These stats are generated by hooks. If you have Kedro-Viz installed and execute `kedro run`, the hooks will generate the stats by default. To disable this, you can disable Kedro-Viz hooks in the settings file of your project.
+
+```{note}
+Starting from Kedro-Viz 9.2.0, the dataset stats file `stats.json` will be moved to `.viz` directory at the root of your Kedro project in-case you have `kedro-viz` installed and had not disabled hooks for `kedro-viz` plugin.
+```
+
 ## Visualise a Kedro project without installing project dependencies
 
 You can use the experimental `--lite` flag to visualise your pipelines without installing Kedro project dependencies. Add the flag to the command you use to start Kedro-Viz:
diff --git a/package/README.md b/package/README.md
index 56bcbffc2..dc543fae1 100644
--- a/package/README.md
+++ b/package/README.md
@@ -283,17 +283,16 @@ For more information on how to use Kedro-Viz in Visual Studio Code, follow this
 
 ## Feature Flags
 
-Kedro-Viz uses features flags to roll out some experimental features. The following flags are currently in use:
-
-| Flag               | Description                                                                             |
-| ------------------ | --------------------------------------------------------------------------------------- |
-| sizewarning        | From release v3.9.1. Show a warning before rendering very large graphs (default `true`) |
-| expandAllPipelines | From release v4.3.2. Expand all modular pipelines on first load (default `false`)       |
+Kedro-Viz uses features flags to roll out some experimental features. No feature flags are currently in use.
 
 To enable or disable a flag, click on the settings icon in the toolbar and toggle the flag on/off.
 
 Kedro-Viz also logs a message in your browser's [developer console](https://developer.mozilla.org/en-US/docs/Learn/Common_questions/What_are_browser_developer_tools#The_JavaScript_console) to show the available flags and their values as currently set on your machine.
 
+
+## Python version support policy
+Kedro Viz supports all Python versions that are actively maintained by the CPython core team. When a [Python version reaches end of life](https://devguide.python.org/versions/#versions), support for that version is dropped from Kedro-viz. This is not considered a breaking change.
+
 ## Maintainers
 
 Kedro-Viz is maintained by the [Kedro team](https://docs.kedro.org/en/stable/contribution/technical_steering_committee.html#kedro-maintainers) and a number of [contributors from across the world](https://github.com/kedro-org/Kedro-Viz/contributors).