search

frictionlessdata / schema-catalog

Community curated Schema Catalog
8 stars 0 forks source link

Add preview a table schema option to the Table Schema Catalog website #1

Open monikappv opened 4 years ago

monikappv commented 4 years ago

We want to make the website as lightweight as possible and we don't want to keep too many stuff on it e.g.

current flow: we are using the table schema data in the catalog.json file to create pages and frontmatter on the website. wanted flow: we retrieve the table schema metadata from the schemas themselves instead of taking them from the catalog.json. in the catalog.json we should leave just title and url so that

  1. it is easier for people to contribute / add new schemas
  2. there's no data repetition (as we would retrieve the data directly from the schemas themselves)

Having this in mind -->

Question:

How do we want to add a table schema preview option to the table schema catalog website?

How do we show the table schemas on the website...?

Acceptance

Tasks

monikappv commented 4 years ago

@rufuspollock as discussed earlier, here's the issue.. please let me know your thoughts

rufuspollock commented 4 years ago

@monikappv it's an open question on exact question of whether you cache a local table schema. IMO it's worth it for the reliability.

However, the real point is right now your total focus is on getting the initial "showcase" page up and working and the MVP route to that is having a local tableschema.json so you can use it in rendering the page ...

rufuspollock commented 4 years ago

@monikappv PS can we get these issues into the table schema catalog repo rather than here in project 😄

monikappv commented 4 years ago

@rufuspollock I see what you mean, we want to get the MVP working and then iterate, but the thing is -

I've already got to the point where I can easily retrieve data from the tableschema.json in gitlab (using the GitLab API) and that's why I'm wondering if it doesn't make more sense to get the schema data that way and use it in rendering the page instead of storing a local version in the repo.

however, there's one thing that I can not fully understand - how do you imagine the previewing of the table schemas? a. like https://git.opendatafrance.net/api/v4/projects/7/repository/files/schema.json/raw?ref=master but the route should be schemas.datahub.io/@org/@schema.json b. just external link leading to something like https://git.opendatafrance.net/api/v4/projects/7/repository/files/schema.json/raw?ref=master c. photo-like table schema d. some other option...

rufuspollock commented 4 years ago

@monikappv integrating pull from another location really comes later once the page is working ...

Can you provide me with a wireframe of the page in google docs including your proposal for preview and then i can comment. (I thought we discussed the other day but maybe not ...)