Document python version policies and other small doc updates. #2139
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Huongg
approved these changes
Oct 14, 2024
There was a problem hiding this comment.
hey @rashidakanchwala the content looks good to me, just left 2 small comments about the styling for note block. Let me know what you think?
| pip install kedro-viz | ||
| ``` | ||
|
|
||
| ```{note} |
There was a problem hiding this comment.
This one makes it wrapped around the code block. Is it intended?
Do we not want it to be in the "note block" instead?
> **Note:** This is a note block in a Markdown file.
There was a problem hiding this comment.
it doesn't render correctly there but it does here - https://kedro--2139.org.readthedocs.build/projects/kedro-viz/en/2139/kedro-viz_visualisation.html
|
|
||
| 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} |
There was a problem hiding this comment.
same here with the code block style
jitu5
reviewed
Oct 14, 2024
| 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. | ||
| ``` | ||
| Please note you can also type `kedro viz` to start Kedro-viz |
There was a problem hiding this comment.
[nit] May be we can keep this under a note block ?
jitu5
approved these changes
Oct 14, 2024
SajidAlamQB
approved these changes
Oct 14, 2024
Signed-off-by: rashidakanchwala <37628668+rashidakanchwala@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR updates the README and Kedro-Viz documentation to include our Python version policies. It also includes a few minor updates to the documentation and README that were made while reviewing these files.
Development notes
QA notes
Checklist
RELEASE.mdfile