Skip to content

Commit

Permalink
Improve Documentation for Custom Starters in kedro new (#2618) (#3771)
Browse files Browse the repository at this point in the history
* Improve Documentation for Custom Starters in kedro new (#2618)

Signed-off-by: Dominik Zalewski <dominikzalewski97@gmail.com>
  • Loading branch information
doxenix committed May 14, 2024
1 parent 9b0195b commit 360cd12
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 3 deletions.
1 change: 1 addition & 0 deletions .github/styles/Kedro/ignore.txt
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ conda
Cookiecutter
config
Dockerfile
doxenix
fsspec
globals
Globals
Expand Down
4 changes: 3 additions & 1 deletion RELEASE.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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)

Expand Down
16 changes: 14 additions & 2 deletions docs/source/starters/starters.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,13 @@ kedro new --starter=<path-to-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
Expand Down Expand Up @@ -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=<path-to-starter> --directory <directory>
```

0 comments on commit 360cd12

Please sign in to comment.