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

Update all readmes #185

Merged
merged 22 commits into from
Nov 23, 2023
Merged

Update all readmes #185

merged 22 commits into from
Nov 23, 2023

Conversation

merelcht
Copy link
Member

@merelcht merelcht commented Nov 21, 2023

Motivation and Context

Closes kedro-org/kedro#3111

I made all spaceflight starter README.md files consistent. And updated any outdated info.

Checklist

  • Opened this PR as a 'Draft Pull Request' if it is work-in-progress
  • Assigned myself to the PR
  • Added tests to cover my changes

Signed-off-by: Merel Theisen <merel.theisen@quantumblack.com>
Signed-off-by: Merel Theisen <merel.theisen@quantumblack.com>
Signed-off-by: Merel Theisen <merel.theisen@quantumblack.com>
Signed-off-by: Merel Theisen <merel.theisen@quantumblack.com>
Signed-off-by: Merel Theisen <merel.theisen@quantumblack.com>
Signed-off-by: Merel Theisen <merel.theisen@quantumblack.com>
@merelcht merelcht self-assigned this Nov 21, 2023
@merelcht merelcht marked this pull request as ready for review November 21, 2023 15:03
Signed-off-by: Jo Stichbury <jo_stichbury@mckinsey.com>
Copy link
Contributor

@stichbury stichbury left a comment

Choose a reason for hiding this comment

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

I made a commit to this branch to change the READMEs. I removed the content about the example code added by tools for now as we discussed it in our docs meeting. It will come back in some form but we decided we need good separation between starters and the code added by tools, so I need to write this/see it written and then add a sentence or two to each starter where needed to explain. Or maybe just link to the framework docs. So this is still to come but you can do that in a separate PR if you want to merge this one.

spaceflights-pyspark-viz/README.md Outdated Show resolved Hide resolved
Copy link
Contributor

@stichbury stichbury left a comment

Choose a reason for hiding this comment

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

LGTM! Sorry for all the extra commits -- I've fixed links and removed a few bits of content and am happy with the result. See what you think. 🏆

stichbury and others added 2 commits November 23, 2023 10:55
Co-authored-by: Merel Theisen <49397448+merelcht@users.noreply.github.com>
Co-authored-by: Merel Theisen <49397448+merelcht@users.noreply.github.com>
@stichbury
Copy link
Contributor

Thanks for the changes @merelcht -- all look good to me. I committed them.

@merelcht merelcht enabled auto-merge (squash) November 23, 2023 11:25
@merelcht merelcht merged commit 1952ef1 into main Nov 23, 2023
18 checks passed
@merelcht merelcht deleted the update-all-readmes branch November 23, 2023 11:40
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.

Update all starter docs/READMEs
3 participants