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

Add documentation for the soft-fail runner if/when it is released in a supported version. #2716

Open
stichbury opened this issue Jun 22, 2023 · 5 comments
Labels
Component: Documentation 📄 Issue/PR for markdown and API documentation

Comments

@stichbury
Copy link
Contributor

We recently added a blog post: https://kedro.org/blog/build-a-custom-kedro-runner

It would to have documentation if the runner is merged into main or spun-out separately into a new package, as discussed here.

This is a ticket to remind us to do this, if and when it happens, and should become a child of any issue that tracks the work needed to convert it from current feature branch to more supported version.

@stichbury stichbury added the Component: Documentation 📄 Issue/PR for markdown and API documentation label Jun 22, 2023
@stichbury
Copy link
Contributor Author

@astrojuanlu
Copy link
Member

xref #503 (comment)

@jmnunezd
Copy link
Contributor

jmnunezd commented Jun 22, 2023

I may not have the full picture bu I totally see this as something worth of adding to the main kedro package

Also, what would be a good argument for not including it?

@stichbury
Copy link
Contributor Author

Also, what would be a good argument for not including it?

At present, @jmnunezd I think one consideration is that it is incomplete, as per this thread https://www.linen.dev/s/kedro/t/12655196/new-blog-post-how-to-build-a-custom-kedro-runner-kedro-in-th#82737ffc-460d-46c8-90a7-9bcd706eff1a

@noklam
Copy link
Contributor

noklam commented Jul 31, 2023

@jmnunezd It's worth to include it, but not our highest priority for now. If someone are willing to take the effort to finish the PR we are more than happy to accept it.

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
Status: No status
Development

No branches or pull requests

4 participants