From 360cd12f3580764d8258daa22e485060f075d139 Mon Sep 17 00:00:00 2001 From: Dominik Zalewski <78603984+doxenix@users.noreply.github.com> Date: Tue, 14 May 2024 13:27:45 +0200 Subject: [PATCH] Improve Documentation for Custom Starters in kedro new (#2618) (#3771) * Improve Documentation for Custom Starters in kedro new (#2618) Signed-off-by: Dominik Zalewski --- .github/styles/Kedro/ignore.txt | 1 + RELEASE.md | 4 +++- docs/source/starters/starters.md | 16 ++++++++++++++-- 3 files changed, 18 insertions(+), 3 deletions(-) diff --git a/.github/styles/Kedro/ignore.txt b/.github/styles/Kedro/ignore.txt index 6de2faf240..76f1165526 100644 --- a/.github/styles/Kedro/ignore.txt +++ b/.github/styles/Kedro/ignore.txt @@ -7,6 +7,7 @@ conda Cookiecutter config Dockerfile +doxenix fsspec globals Globals diff --git a/RELEASE.md b/RELEASE.md index 8d2b98f0b9..34c23572e4 100644 --- a/RELEASE.md +++ b/RELEASE.md @@ -7,8 +7,11 @@ ## Breaking changes to the API ## Documentation changes +* Improved documentation for custom starters ## Community contributions +Many thanks to the following Kedroids for contributing PRs to this release: +* [doxenix](https://github.com/doxenix) # Release 0.19.5 @@ -50,7 +53,6 @@ ## Community contributions Many thanks to the following Kedroids for contributing PRs to this release: - * [ondrejzacha](https://github.com/ondrejzacha) * [Puneet](https://github.com/puneeter) diff --git a/docs/source/starters/starters.md b/docs/source/starters/starters.md index 04a0dd87a9..33c09d3f20 100644 --- a/docs/source/starters/starters.md +++ b/docs/source/starters/starters.md @@ -11,7 +11,13 @@ kedro new --starter= ``` ```{note} -`path-to-starter` could be a local directory or a VCS repository, as long as [Cookiecutter](https://cookiecutter.readthedocs.io/en/stable/usage.html) supports it. +`path-to-starter` could be the path to a local directory, a URL to a remote VCS repository supported by `cookiecutter` or one of the aliases listed in ``kedro starter list``. +``` + +If you want to use `--starter` as remote VCS repository, run: + +```bash +kedro new --starter git+https://github.com/kedro-org/kedro-starters.git --directory spaceflights-pandas ``` ## Starter aliases @@ -79,5 +85,11 @@ kedro new --config=my_kedro_project.yml --starter=spaceflights-pandas This option is useful when the starter requires more configuration than the default mode requires. -## Create a starter +## Create a custom starter You can build your own starters for reuse within a project or team, as described in the [how to create a Kedro starter](../starters/create_a_starter.md) documentation. + +To create a project from a custom starter, run: + +```bash +kedro new --starter= --directory +```