search

hasura / ddn-docs

Repository for the Hasura DDN version of docs
https://hasura.io/docs
2 stars 6 forks source link

Docs: Add Data Modeling section #732

Open robertjdominguez opened 23 hours ago

robertjdominguez commented 23 hours ago

Description 📝

Adds a Data Modeling section that provides simple user-facing language, allowing them to see a connection between their preferred data source + Hasura DDN concepts. Ideally, this is the next section a user will encounter when taking their first steps after the quickstart/getting-started guides.

The language is intentionally direct and concise. As an example, each page in the new directory has a sidebar-level explanation of what a metadata object does. Further, within the pages, we provide users with a clear idea of when / why they'll want to perform certain operations and give them connector-specific implementations. Yes, there will be duplication here as some operations are the same across connectors, but we want them to feel "at home" with their connector in our docs.

TODO

Quick Links 🚀

New data modeling section

Instructions for contributors

As of opening this PR, I've stubbed out all the necessary pages for this directory. Additionally, there's a near-complete set of Postgres docs for the Models page. This will need to be completed and the template followed for the other pages and connectors. Similar to #731, contributors should:

  1. Create a new branch off rob/docs/add-data-modeling-concepts
  2. Fill in their connector's respective examples across all pages
  3. Open a PR and ping Rob
hasura-bot commented 23 hours ago

@robertjdominguez Thanks for your PR! I've assigned @robertjdominguez to review it.