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.

Sign up for GitHub

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

Jump to bottom

Improve Documentation for Custom Starters in kedro new (#2618) #3771

Merged
merged 7 commits into from
May 14, 2024
Merged

Improve Documentation for Custom Starters in kedro new (#2618) #3771

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
a608ffb
Improve Documentation for Custom Starters in kedro new (#2618)
doxenix Apr 4, 2024
093664c
Merge branch 'main' into fix/2618
doxenix Apr 4, 2024
7e18c7c
Update ignore.txt
astrojuanlu May 6, 2024
e91cd2e
Merge branch 'main' into fix/2618
astrojuanlu May 6, 2024
a56bb53
Update release notes
merelcht May 14, 2024
6ee1930
Update release notes
merelcht May 14, 2024
db6048e
Merge branch 'main' into fix/2618
merelcht May 14, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
1 change: 1 addition & 0 deletions .github/styles/Kedro/ignore.txt
View file
Open in desktop
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
View file
Open in desktop
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:

Check warning on line 13 in RELEASE.md

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Kedro.weaselwords] 'Many' is a weasel word!

Raw Output:
{"message": "[Kedro.weaselwords] 'Many' is a weasel word!", "location": {"path": "RELEASE.md", "range": {"start": {"line": 13, "column": 1}}}, "severity": "WARNING"}

Check warning on line 13 in RELEASE.md

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Kedro.Spellings] Did you really mean 'Kedroids'?

Raw Output:
{"message": "[Kedro.Spellings] Did you really mean 'Kedroids'?", "location": {"path": "RELEASE.md", "range": {"start": {"line": 13, "column": 30}}}, "severity": "WARNING"}
* [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
View file
Open in desktop
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>
```