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

Standardise terminology for starters #2422

Closed
amandakys opened this issue Mar 14, 2023 · 3 comments
Closed

Standardise terminology for starters #2422

amandakys opened this issue Mar 14, 2023 · 3 comments
Labels
Component: CLI Issue/PR that addresses the CLI for Kedro Component: Documentation 📄 Issue/PR for markdown and API documentation Design: Research Type: Parent Issue

Comments

@amandakys
Copy link

Introduction

We refer to Kedro starters interchangeably as starters, templates or starter templates.

It would be good to standardise how we refer to them across the CLI and the docs

Design

I propose changing starter to template as it is the more common name for what they are. alternatives could include:

  • quickstart
  • samples (used by Azure and Google)

This would change the CLI command kedro new --starter=spaceflights to kedro new --template=spaceflights

Rollout

This change can be made as part of the rollout of the new kedro new flow proposed in #2388

@datajoely
Copy link
Contributor

Tangentially, I've always disliked that kedro starter list and kedro new --starter are completely disconnected

@amandakys
Copy link
Author

The new kedro new flow proposed in #2388 might address that because it adds a 'select a starter' section to the project initialisation flow with a list of available starters and a short description. Maybe with that we can deprecate kedro starter list

(my-virtual-environment) ➜  kedro new 

Project Template
=============
Choose a project template for your new project. 
- astro-airflow-iris: An Iris dataset example project with a minimal setup for deploying the pipeline on Airflow with Astronomer
- blank: A minimal project template
- pandas-iris: An Iris dataset example using Pandas
- pyspark: Configuration and inistialisation for a PySpark pipeline
- pyspark-iris: An Iris dataset example using PySpark 
- spaceflights: Spaceflights tutorial example code
- standalone-datacatalog: A minimum setup to use Kedro's DataCatalog

 [Select your template]: blank

@DimedS
Copy link
Contributor

DimedS commented Dec 18, 2023

Discussed on 18.12.23 during Issue Grooming. We decided not to proceed with that as it appears to be no longer relevant. Additionally, it was not included in the 0.19 release.

@DimedS DimedS closed this as completed Dec 18, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Component: CLI Issue/PR that addresses the CLI for Kedro Component: Documentation 📄 Issue/PR for markdown and API documentation Design: Research Type: Parent Issue
Projects
Archived in project
Development

No branches or pull requests

5 participants