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

Rationalise data catalog examples in documentation #1742

Closed
1 of 2 tasks
merelcht opened this issue Aug 1, 2022 · 3 comments
Closed
1 of 2 tasks

Rationalise data catalog examples in documentation #1742

merelcht opened this issue Aug 1, 2022 · 3 comments
Labels
Component: Documentation 📄 Issue/PR for markdown and API documentation

Comments

@merelcht
Copy link
Member

merelcht commented Aug 1, 2022

Description

In the section on using the DataCatalog with the yaml api, we've listed a lot of examples: https://kedro.readthedocs.io/en/stable/data/data_catalog.html#use-the-data-catalog-with-the-yaml-api. However, there are no anchors to any of these examples, so it's very hard to link users to a specific solution.

Implementation

  • Add anchors to data_catalog.md examples #1770
  • Create a separate page for these examples altogether or alternatively, only keep some of the example in Data Catalog to showcase what Kedro can do, but move the advanced examples to the corresponding API Docs.
@merelcht merelcht added the Component: Documentation 📄 Issue/PR for markdown and API documentation label Aug 1, 2022
@merelcht merelcht changed the title Create headings on Data Catalog yaml example section Create headings on Data Catalog yaml examples + move advanced examples to api docs Aug 5, 2022
@antonymilne antonymilne changed the title Create headings on Data Catalog yaml examples + move advanced examples to api docs Rationalise data catalog examples in documentation Sep 5, 2022
@noklam
Copy link
Contributor

noklam commented Sep 5, 2022

I think "Data Catalog" should show case what Kedro can do, showing examples for saving things in remote storage, but we don't need all the combination of DataSet + Remote Storage type.

This should make the page itself shorter, the more repeated example can be moved to the specific DataSet API docs instead.

@stichbury
Copy link
Contributor

This issue, plus #2287 and #1762 all seem to point to improving the API docs and streamlining the DataCatalog docs. I agree with @noklam that it would make sense to extract some of the examples to put them in API docs (or elsewhere).

@stichbury
Copy link
Contributor

Also to add that the page needs a significant rework to simplify it and attempt to make it more discoverable through search as per this discussion https://kedro-org.slack.com/archives/C03RKP2LW64/p1673459017999699

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

3 participants