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

Revise documentation that uses the iris starter #3160

Closed
13 tasks done
Tracked by #3158
stichbury opened this issue Oct 11, 2023 · 7 comments
Closed
13 tasks done
Tracked by #3158

Revise documentation that uses the iris starter #3160

stichbury opened this issue Oct 11, 2023 · 7 comments
Assignees
Labels
Component: Documentation 📄 Issue/PR for markdown and API documentation

Comments

@stichbury
Copy link
Contributor

stichbury commented Oct 11, 2023

Parent ticket #3158

Pages impacted:

  • docs/source/kedro_project_setup/starters.md
  • docs/source/get_started/new_project.md (significant)
  • docs/source/notebooks_and_ipython/kedro_and_notebooks.md (significant)
  • docs/source/notebooks_and_ipython/kedro_as_a_data_registry.md (being removed anyway)
  • docs/source/deployment/airflow_astronomer.md <-- the starter is retained
  • docs/source/deployment/databricks/databricks_notebooks_development_workflow.md <-- the starter is retained
  • docs/source/deployment/databricks/databricks_deployment_workflow.md <-- the starter is retained
  • docs/source/deployment/databricks/databricks_visualisation.md <-- the starter is retained
  • docs/source/deployment/databricks/databricks_ide_development_workflow.md <-- the starter is retained
  • docs/source/hooks/examples.md
  • docs/source/nodes_and_pipelines/run_a_pipeline.md (insignificant)
  • docs/source/nodes_and_pipelines/nodes.md (affects the Generators section)
  • docs/source/extend_kedro/plugins.md
@stichbury
Copy link
Contributor Author

Changes are going into the PR #3317

@stichbury
Copy link
Contributor Author

There's a section of documentation about generators here: https://docs.kedro.org/en/stable/nodes_and_pipelines/nodes.html#how-to-use-generator-functions-in-a-node

It uses the pandas-iris starter and I'm not sure how to remove that without rewriting the section. Some ideas from most effort to least:

  • Update the docs to use a different starter
  • Temporarily tie this to a fixed version of the starter (so give instructions for using the archived starter code with Kedro 0.18.14 or earlier, and link to docs about the iris starter in 0.18.14 set).
  • Remove entirely in 0.19.0 and make into new documentation when time permits.

I would vote for the first or second option but it's not my time needed to do the changes. What do you think @noklam @merelcht? cc @astrojuanlu

@astrojuanlu
Copy link
Member

I support (2) hence temporarily tie this to the 0.18.14 starter, and maybe add an admonition on top that says "these docs use an old version, we will update them soon" or something like that. Otherwise if we remove them the link is broken. And updating the docs is a distraction right now.

@merelcht
Copy link
Member

I would also vote for option 2!

@stichbury
Copy link
Contributor Author

@merelcht How would I invoke the starter, is something like:

kedro new --starter=pandas-iris --checkout=0.18.14

@merelcht
Copy link
Member

@merelcht How would I invoke the starter, is something like:

kedro new --starter=pandas-iris --checkout=0.18.14

Yes that works. It might be good to add that the user would need to have kedro 0.18.14 installed in their environment. This doesn't work if they are on 0.19.0 when it's released.

@astrojuanlu
Copy link
Member

This was done in #3317

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
Archived in project
Development

No branches or pull requests

3 participants