-
Notifications
You must be signed in to change notification settings - Fork 909
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
Final clean up for kedro pipeline create
and kedro catalog create
docs
#2918
Comments
kedro pipeline create
and starters to ensure consistencykedro pipeline create
and starters
just to confirm - this |
Good remarks. Perhaps we should enhance the README.md in the starters pipelines with a good examples. |
@amandakys - it doesn't create On the other hand, I am in favor of deleting it as it doesn't add much value. Some users, especially for the larger project they do document pipelines separately with |
Inconsistency 1: discussed in backlog grooming all good to remove the pipeline level
Inconsistency 3: link should be changed to |
kedro pipeline create
and starterskedro pipeline create
kedro pipeline create
kedro pipeline create
and kedro catalog create
docs
Following some discussion in #2888 which updates Data Catalog docs, we agreed that we need to update the text that mentions this command in the two places it appears (data catalog docs and CLI reference). Please consider those changes part of the definition of done for this issue. |
@stichbury I actually just look into the PR again. It more likely we should fix it in #2888. It's likely due to when you start this docs change, the PR hasn't been merged so you have a older copy. Because your change actually deleted the whole I |
Description
Steps to reprdouce:
Inconsistency 1 -
kedro pipeline create
addREADME.md
while starter doesn't have itInconsistency 2 - CLI docstring seems to be outdated.
https://github.com/kedro-org/kedro/blob/6888001c6019059ae717c99fbe26a06f67d73ca2/kedro/framework/cli/catalog.py#L131C1-L141C8
Inconsistency 3 - broken doc
It generates a link that doesn't exist - https://docs.kedro.org/en/0.18.12/kedro_project_setup/configuration.html#parameters
See this:
kedro/kedro/templates/pipeline/{{ cookiecutter.pipeline_name }}/config/parameters_{{ cookiecutter.pipeline_name }}.yml
Line 5 in 6888001
Also, any idea it is in a folder called
config
but notconf
?Outdated Doc 4
See #2888 (comment)
Context
Possible Implementation
Possible Alternatives
The text was updated successfully, but these errors were encountered: