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

Tweak new tools/example workflow description #3454

Merged
merged 14 commits into from
Dec 22, 2023
Merged

Conversation

stichbury
Copy link
Contributor

@stichbury stichbury commented Dec 20, 2023

Description

Created this to make a few minor tweaks to the docs about the kedro newworkflow where tools & examples are described. This is a preview of the page most impacted: https://kedro--3454.org.readthedocs.build/en/3454/get_started/new_project.html

Development notes

  • Added copy to reproduce what the console says to make it easier for a reader to match up the docs and practical experience
  • Added some quickstart examples as a "cheatsheet"
  • Attempted to explain the example projects a little more clearly as it's super-complicated at first sight.
  • Few minor formatting issues

Developer Certificate of Origin

We need all contributions to comply with the Developer Certificate of Origin (DCO). All commits must be signed off by including a Signed-off-by line in the commit message. See our wiki for guidance.

If your PR is blocked due to unsigned commits, then you must follow the instructions under "Rebase the branch" on the GitHub Checks page for your PR. This will retroactively add the sign-off to all unsigned commits and allow the DCO check to pass.

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

@stichbury stichbury added the Component: Documentation 📄 Issue/PR for markdown and API documentation label Dec 20, 2023
@stichbury stichbury self-assigned this Dec 20, 2023
Signed-off-by: Jo Stichbury <jo_stichbury@mckinsey.com>
Signed-off-by: Jo Stichbury <jo_stichbury@mckinsey.com>
Signed-off-by: Jo Stichbury <jo_stichbury@mckinsey.com>
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.

Nice work @stichbury - I left some comments, mainly to correct some of the quickstart one-liners but also to make the walkthrough more aligned with the current result. There's a question about how much of the actual text we want to include.

docs/source/get_started/new_project.md Outdated Show resolved Hide resolved
docs/source/get_started/new_project.md Outdated Show resolved Hide resolved
docs/source/get_started/new_project.md Outdated Show resolved Hide resolved
docs/source/get_started/new_project.md Show resolved Hide resolved
docs/source/get_started/new_project.md Outdated Show resolved Hide resolved
docs/source/get_started/new_project.md Outdated Show resolved Hide resolved
docs/source/get_started/new_project.md Outdated Show resolved Hide resolved
stichbury and others added 6 commits December 21, 2023 14:29
Co-authored-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com>
Signed-off-by: Jo Stichbury <jo_stichbury@mckinsey.com>
Co-authored-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com>
Signed-off-by: Jo Stichbury <jo_stichbury@mckinsey.com>
Co-authored-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com>
Signed-off-by: Jo Stichbury <jo_stichbury@mckinsey.com>
Co-authored-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com>
Signed-off-by: Jo Stichbury <jo_stichbury@mckinsey.com>
Co-authored-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com>
Signed-off-by: Jo Stichbury <jo_stichbury@mckinsey.com>
Co-authored-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com>
Signed-off-by: Jo Stichbury <jo_stichbury@mckinsey.com>
@stichbury
Copy link
Contributor Author

Thanks for the review @astrojuanlu -- all changes accepted.

Signed-off-by: Jo Stichbury <jo_stichbury@mckinsey.com>
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.

LGTM 🚀

Copy link
Contributor

@DimedS DimedS left a comment

Choose a reason for hiding this comment

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

Thanks, @stichbury . More clear now!

@stichbury
Copy link
Contributor Author

I could merge this but would value any insight from @AhdraMeraliQB since she worked on these docs prior to the release, and has the best context. I'll hold off on a merge until she's had a chance to feed back.

Copy link
Contributor

@AhdraMeraliQB AhdraMeraliQB left a comment

Choose a reason for hiding this comment

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

These look amazing! I really like the addition of "next" and "finally" to connect how the prompts flow together, and I love the Quickstart examples section! 🌟

@stichbury stichbury enabled auto-merge (squash) December 22, 2023 18:59
@stichbury stichbury merged commit 2e64459 into main Dec 22, 2023
11 checks passed
@stichbury stichbury deleted the fix-docs-new-project branch December 22, 2023 19:03
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.

4 participants