[KED-2409] Update docs to remind on compatibility of Kedro-Viz 3.8.0 with Kedro 0.17 #367
Conversation
studioswong
requested review from
richardwestenra and
yetudada
as code owners
|
Could we also add it to the RELEASE.md too? |
There was a problem hiding this comment.
Left minor comments on capitalisation but otherwise I'm all happy. Thank you @studioswong!
richardwestenra
changed the title
Co-authored-by: Yetunde Dada <[email protected]>
Co-authored-by: Yetunde Dada <[email protected]>
Co-authored-by: Yetunde Dada <[email protected]>
| @@ -23,6 +23,8 @@ This project was bootstrapped with [Create React App](https://github.com/faceboo | |||
|
|
|||
| > For in-depth development and usage notes, see the [Contribution Guidelines](https://github.com/quantumblacklabs/kedro-viz/blob/main/CONTRIBUTING.md). | |||
|
|
|||
| > It's likely that Kedro-Viz>=3.8.0 will not work with projects created with older versions of Kedro<=0.16.6. Please migrate your project to Kedro>=0.17.0 before installation of the latest version of Kedro-Viz. | |||
There was a problem hiding this comment.
| > It's likely that Kedro-Viz>=3.8.0 will not work with projects created with older versions of Kedro<=0.16.6. Please migrate your project to Kedro>=0.17.0 before installation of the latest version of Kedro-Viz. | |
| > It's likely that Kedro-Viz>=3.8.0 will not work with projects created with older versions of Kedro<=0.16.6. Please migrate your project to Kedro>=0.17.0 before you install the latest version of Kedro-Viz. |
There was a problem hiding this comment.
"It's likely..." is one of those terms that fills me with concern. Will it? Won't it? How will I know? I think we need to be definite and say it won't.
There was a problem hiding this comment.
thank you for raising this @stichbury ! From our testing, Kedro-Viz 3.8.0 will work with older versions of Kedro, however the problem lies with many users running latest Kedro viz on Kedro 17 against
Regardless, for the wording I had taken the exact same wording that was in the Kedro release notes ( please see below conversation on slack) - my approach here is to follow what was stated in the kedro-release notes ( given that this incompatibility was not introduced by Kedro-viz but rather with the new Kedro upgrades.) The point of including this note here is just merely to reinterate / plug the gap.
I am not sure we can say it won't since actually it would work on older versions of Kedro ( provided it's on Kedro 16 with Kedro 16 project), but it could likely won't because of the incompatibility between the kedro project and kedro. @yetudada @stichbury would love your thoughts on how I should proceed with this sticky situation?
Co-authored-by: Jo Stichbury <[email protected]>
Co-authored-by: Jo Stichbury <[email protected]>
# Release 3.9.0 ## Major features and improvements - Add code panel (#346) - Improve view panning behaviour when a node is selected (#356, #363, #370, #373, #374) - Improve layout performance for large graphs (#343) - Save tag state to localStorage (#353) ## Bug fixes and other changes - Improve graph layout code quality, performance and docs (#347) - Update docs to remind on compatibility of Kedro-Viz 3.8.0 with Kedro 0.17 (#367) - Update dependencies (#360, #364, #369) - Fix failing CircleCI build on Windows (#365, #366) - Refactor node-list-row CSS, fixing hover and focus states (#355, #358, #362) - Update iconography (#357, #359) - Fix missing indicator Chrome zoom bug (#349) - Fix sidebar border/box-shadow CSS rules (#351) - Fix server.py to work with versions >0.17 and update contributing docs (#348) - Fix errors when scrolling with empty pipeline (#342) - Ignore coverage on some branches and fix e2e tests (#345) - Fix icon-button tooltips on mobile (#344) - Update SVG-Crowbar to fix errors (#339) - Update contributing docs for new dev server (#341)
Description
Related ticket: https://jira.quantumblack.com/browse/KED-2409
This ticket is raised given the imcompatibility issues experienced by Go, which raises the need to update our docs to remind our users of compatibility issues and to update to the latest version of Kedro to install and run the latest version of Kedro-Viz.
Development notes
I have updated both the readme and the contributing docs.
QA notes
N/A
Checklist
RELEASE.mdfileLegal notice
I acknowledge and agree that, by checking this box and clicking "Submit Pull Request":
I submit this contribution under the Apache 2.0 license and represent that I am entitled to do so on behalf of myself, my employer, or relevant third parties, as applicable.
I certify that (a) this contribution is my original creation and / or (b) to the extent it is not my original creation, I am authorised to submit this contribution on behalf of the original creator(s) or their licensees.
I certify that the use of this contribution as authorised by the Apache 2.0 license does not violate the intellectual property rights of anyone else.