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

[Ready] Changes to improve existing content about notebook development & kedro #3127

Merged
merged 9 commits into from
Oct 11, 2023

Conversation

stichbury
Copy link
Contributor

@stichbury stichbury commented Oct 5, 2023

NOTE: Kedro datasets are moving from kedro.extras.datasets to a separate kedro-datasets package in
kedro-plugins repository. Any changes to the dataset implementations
should be done by opening a pull request in that repository.

Description

Built docs are here

This answers #2845 by improving the content of the documentation page that describes how to combine a Kedro project with notebooks for data exploration. It also removes the standalone-datacatalog page which was ill-advised as it's not really about notebooks (I've moved it temporarily into the README for the starter).

This is part of a pair of PRs (#3128 is the other) to revise notebook docs. This one describes the "Add a notebook to Kedro projects" workflow, while #3128 describes the "Add Kedro to a notebook" workflow. They meet in the middle but I've separated them because I didn't want any one PR getting too complex.

Development notes

Changes to screenshots and copy.

Checklist

  • Read the contributing guidelines
  • Signed off each commit with a Developer Certificate of Origin (DCO)
  • Opened this PR as a 'Draft Pull Request' if it is work-in-progress
  • Updated the documentation to reflect the code changes
  • Added a description of this change in the RELEASE.md file
  • Added tests to cover my changes
  • Checked if this change will affect Kedro-Viz, and if so, communicated that with the Viz team

Signed-off-by: Jo Stichbury <jo_stichbury@mckinsey.com>
Signed-off-by: Jo Stichbury <jo_stichbury@mckinsey.com>
@stichbury stichbury added the Component: Documentation 📄 Issue/PR for markdown and API documentation label Oct 5, 2023
@stichbury stichbury self-assigned this Oct 5, 2023
@stichbury
Copy link
Contributor Author

stichbury commented Oct 5, 2023

I'm not sure why the RTD build is failing as I've built successfully locally

@stichbury stichbury marked this pull request as ready for review October 10, 2023 10:30
@stichbury stichbury changed the title [Draft] Changes to improve existing content about notebook development & kedro [Ready] Changes to improve existing content about notebook development & kedro Oct 10, 2023
Signed-off-by: Jo Stichbury <jo_stichbury@mckinsey.com>
Copy link
Member

@merelcht merelcht left a comment

Choose a reason for hiding this comment

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

Looks great! 👍 ⭐

Copy link
Contributor

@SajidAlamQB SajidAlamQB left a comment

Choose a reason for hiding this comment

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

Thank you @stichbury! 🌟

Copy link
Member

@astrojuanlu astrojuanlu left a comment

Choose a reason for hiding this comment

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

Sorry for the delayed review, this somehow fell through the cracks.

I think this PR is an improvement over what we had before and it's ready to go in. However, I also believe that the real game changer for this page will be de-emphasizing custom kernels, de-emphasizing kedro jupyter, and placing more emphasis in %load_ext kedro.ipython, as I suggested in this other issue #2777

That can be done in a separate PR so LGTM 👍🏽

Copy link
Contributor

@ankatiyar ankatiyar left a comment

Choose a reason for hiding this comment

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

Read through the built docs and it looks great!

@stichbury stichbury enabled auto-merge (squash) October 11, 2023 17:04
@stichbury stichbury merged commit b2624c5 into main Oct 11, 2023
11 checks passed
@stichbury stichbury deleted the revise-existing-notebook-docs branch October 11, 2023 17:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Component: Documentation 📄 Issue/PR for markdown and API documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants