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

Add documentation on use of metadata in data catalog (and with Kedro-Viz) #1650

Closed
AhdraMeraliQB opened this issue Jun 14, 2023 · 4 comments
Closed

Comments

@AhdraMeraliQB
Copy link
Contributor

Introduction

Viz now processes dataset layer and preview information from the metadata attribute. We should document how users are able to make use of these.

Formatting suggestion

  1. Replace the section "Visualise layers" on this page with "Using metadata for added visualisation", or something to that effect. "Visualise layers" then becomes a subsection under that heading, and we introduce the subsection "Preview datasets" with instruction on how to use metadata to enable previews.

  2. Add the bullet "Metadata" to https://docs.kedro.org/en/stable/data/data_catalog.html#use-the-data-catalog-within-kedro-configuration, potentially link to the section described in point 1 or the section introduced in Document datasets' metadata attribute in catalog definition kedro#2676 (or both!)

@stichbury
Copy link
Contributor

This looks great to me @AhdraMeraliQB I'd be delighted to see this change/improvement.

@NeroOkwa
Copy link
Contributor

Agreed! @AhdraMeraliQB this would help users understand how to enable the use of metadata.

@stichbury
Copy link
Contributor

I think part 1. of this issue is still to do so I'll transfer this to the Viz team to action on the doc when convenient

cc @rashidakanchwala

@NeroOkwa NeroOkwa transferred this issue from kedro-org/kedro Nov 20, 2023
@rashidakanchwala rashidakanchwala moved this from Todo to Backlog in Kedro-Viz Nov 20, 2023
@rashidakanchwala rashidakanchwala moved this from Backlog to In Progress in Kedro-Viz Feb 21, 2024
@rashidakanchwala rashidakanchwala self-assigned this Feb 21, 2024
@rashidakanchwala rashidakanchwala moved this from In Progress to Done in Kedro-Viz Mar 4, 2024
@rashidakanchwala
Copy link
Contributor

Closing this as done

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Done
Development

No branches or pull requests

4 participants