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 Data Catalog documentation to bring it up-to-date and simplify it #2521

Closed
Tracked by #2919
stichbury opened this issue Apr 17, 2023 · 3 comments
Closed
Tracked by #2919
Assignees
Labels
Component: Documentation 📄 Issue/PR for markdown and API documentation

Comments

@stichbury
Copy link
Contributor

Description

Based on #2488, the goal is to take the pages as discussed and move content into a more intuitive set of pages for introduction/basic usage/advanced usage and examples

There is a definite need to do this as the Data Catalog pages are some of the most visited, and the update will remove some of the incorrect or plain confusing material.

However, since there will be some upcoming discussion on information architecture and docs usability, it may be that this happens in two phases: first improve the docs as discussed in #2488 and then make final tweaks if needed for the output of the IA review.

@astrojuanlu
Copy link
Member

Inspiration: https://stackoverflow.com/q/76765840/554319

@stichbury stichbury moved this from To Do to In Progress in Kedro Framework Jul 31, 2023
@stichbury
Copy link
Contributor Author

Joel made a good point that the factory documentation isn't easy to spot and should be highlighted: https://docs.kedro.org/en/latest/data/data_catalog.html#example-3-generalise-datasets-using-namespaces-into-one-dataset-factory

@stichbury stichbury moved this from In Progress to In Review in Kedro Framework Aug 17, 2023
@astrojuanlu
Copy link
Member

Closed in #2888, opened a few follow-up tickets from there.

@github-project-automation github-project-automation bot moved this from In Review to Done in Kedro Framework Aug 18, 2023
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