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

Document python version policies and other small doc updates. #2139

Merged
merged 3 commits into from
Oct 14, 2024

Conversation

rashidakanchwala
Copy link
Contributor

@rashidakanchwala rashidakanchwala commented Oct 14, 2024

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

  • Read the contributing guidelines
  • Opened this PR as a 'Draft Pull Request' if it is work-in-progress
  • Updated the documentation to reflect the code changes
  • Added new entries to the RELEASE.md file
  • Added tests to cover my changes

Signed-off-by: rashidakanchwala <rashida_kanchwala@mckinsey.com>
@rashidakanchwala rashidakanchwala marked this pull request as ready for review October 14, 2024 08:40
Copy link
Contributor

@Huongg Huongg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This one makes it wrapped around the code block. Is it intended?

Screenshot 2024-10-14 at 11 29 12

Do we not want it to be in the "note block" instead?

> **Note:** This is a note block in a Markdown file.

Copy link
Contributor Author

@rashidakanchwala rashidakanchwala Oct 14, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.


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}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

same here with the code block style

Screenshot 2024-10-14 at 11 31 37

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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[nit] May be we can keep this under a note block ?

Signed-off-by: rashidakanchwala <37628668+rashidakanchwala@users.noreply.github.com>
@rashidakanchwala rashidakanchwala merged commit 2eb18d9 into main Oct 14, 2024
25 checks passed
@rashidakanchwala rashidakanchwala deleted the doc-readme-updates branch October 14, 2024 11:09
@rashidakanchwala rashidakanchwala mentioned this pull request Nov 21, 2024
5 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants