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

Update documentation to reflect the new kedro new add-ons flow #3048

Closed
Tracked by #3158
AhdraMeraliQB opened this issue Sep 19, 2023 · 11 comments
Closed
Tracked by #3158

Update documentation to reflect the new kedro new add-ons flow #3048

AhdraMeraliQB opened this issue Sep 19, 2023 · 11 comments
Assignees
Labels
Component: Documentation 📄 Issue/PR for markdown and API documentation

Comments

@AhdraMeraliQB
Copy link
Contributor

AhdraMeraliQB commented Sep 19, 2023

Description

Make sure any references to kedro new are updated in accordance with the new changes. Additionally a section should be added detailing this new flow, what it means to users, and how to use it (in CLI and via config file).

These docs should mention all add-ons added in the tickets:

@AhdraMeraliQB
Copy link
Contributor Author

There are a couple placeholders in the files as well - make sure to do a search and replace the # TODO; Insert actual link to the documentation. and kedro.org/{insert-documentation}

@astrojuanlu
Copy link
Member

@stichbury can give a more informed opinion in a few days, but maybe if we were to start writing these docs, shall we put them under https://docs.kedro.org/en/stable/kedro_project_setup/? For example https://docs.kedro.org/en/stable/kedro_project_setup/addons.html (hence docs/source/kedro_project_setup/addons.md)

cc @AhdraMeraliQB @amandakys

@stichbury
Copy link
Contributor

I don't think something as significant should go into /kedro_project_setup which is one of the docs sections that is still in need of general attention and improvement. This is surely an update for the early onboarding content?

@astrojuanlu
Copy link
Member

Good point, I hadn't realized that was listed under "Advanced". But that's where the starters are explained, so I thought it would be the natural place. Feel free to suggest otherwise.

@stichbury
Copy link
Contributor

stichbury commented Oct 30, 2023

Yeah I think https://docs.kedro.org/en/stable/kedro_project_setup/starters.html needs to be split into two:

  • Introduction to Kedro starters (which moves into the "Kedro projects" section
  • How to create a Kedro starter which stays in the Advanced section

The add-ons work goes with the first item, except where it is even more basic on-boarding content that describes how to make a first project etc.

Update: This branch has the starter (pun intended) of this split and should be used as the basis for the additions for add-ons content.

@astrojuanlu
Copy link
Member

Sounds perfect to me 👍🏽

@stichbury
Copy link
Contributor

See also #3201 (to improve 'project setup' docs) and #3161 (to improve starters docs) as related tickets.

@merelcht
Copy link
Member

merelcht commented Nov 3, 2023

This needs engineering input, so tagging/assigning the engineers who have done most of the add-ons work so far to help out with this @noklam @SajidAlamQB @AhdraMeraliQB @lrcouto @DimedS.

@astrojuanlu astrojuanlu moved this from To Do to In Progress in Kedro Framework Nov 13, 2023
@stichbury
Copy link
Contributor

stichbury commented Nov 16, 2023

I have now created a PR which has marked where changes are necessary to address the add-ons flow changes.

Please can I pass this to one or more of @noklam @SajidAlamQB @AhdraMeraliQB @lrcouto @DimedS (as noted by @merelcht) to do a pass over the docs. Look for comments notes in the following:

  • onboarding docs (get_started folder)
  • tutorial setup (tutorial_template.md)
  • addons_and_starters folder

@AhdraMeraliQB
Copy link
Contributor Author

Closed by #3331

@github-project-automation github-project-automation bot moved this from In Review to Done in Kedro Framework Dec 8, 2023
@DimedS
Copy link
Contributor

DimedS commented Dec 8, 2023

Apologies for the delayed response. New docs section looks really great 👍 .
But it appears we should add a mention of "example_pipeline" in the documentation here
This clarification is necessary because, as it stands, users might not realize they need to specify "example_pipeline" in the config.yml file, rather than just "example" as when using the CLI.

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

When branches are created from issues, their pull requests are automatically linked.

8 participants