diff --git a/RELEASE.md b/RELEASE.md index 31b082842f..5a4a87dc2c 100644 --- a/RELEASE.md +++ b/RELEASE.md @@ -27,6 +27,7 @@ Many thanks to the following Kedroids for contributing PRs to this release: * [ondrejzacha](https://github.com/ondrejzacha) +* [doxenix](https://github.com/doxenix) # Release 0.19.3 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 +```