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

Docs: In CLI reference, add more detail about flags that can be passed to kedro new and point to detailed docs #3359

Open
stichbury opened this issue Nov 29, 2023 · 1 comment
Labels
Component: Documentation 📄 Issue/PR for markdown and API documentation

Comments

@stichbury
Copy link
Contributor

Description

We need to add some more information about how to find out about the flags available when calling kedro new to this page: https://docs.kedro.org/en/stable/development/commands_reference.html#create-a-new-kedro-project

We should have had it before (I thought we did!) and although we don't need a complete level of detail it would be sensible to point through to the new docs we are creating at present to describe all the flags.

Priority?

I don't think this is a blocker right now but we should add it in shortly after release since it is important for people that use the CLI reference that they have up-to-date info on where to find out more about commands. I should review this entire page to make sure there aren't other cross references that would help readers find out more from the reference.

Side quest

Make a cheatsheet

@stichbury stichbury added the Component: Documentation 📄 Issue/PR for markdown and API documentation label Nov 29, 2023
@stichbury
Copy link
Contributor Author

This probably makes sense as part of #2604 so I'll say this is work that should be tackled in tandem with a more general tidy up of the CLI reference.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Component: Documentation 📄 Issue/PR for markdown and API documentation
Projects
None yet
Development

No branches or pull requests

2 participants