Skip to content

Docs: Turn data modeling into semantic metadata under core concepts #174

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 5 commits into from
Jul 8, 2025
Merged

Docs: Turn data modeling into semantic metadata under core concepts #174

merged 5 commits into from
Jul 8, 2025

Conversation

robertjdominguez
Copy link
Collaborator

@robertjdominguez robertjdominguez commented Jul 7, 2025 •
edited
Loading

Description 📝

Transforms the data modeling section into semantic metadata according to the HEP.

Quick Links 🚀

Metadata's index

@robertjdominguez
Docs: Refactor data-modeling » metadata
b7686f9 
Refactors the `data-modeling` directory into `metadata` and updates refs for builds.

Additionally, we simplify the language in the sidebar for the page names while also grouping the guides into a subdirectory. Next step will be to
re-write the various metadata pages to make them easier to grok (conceptually).
@robertjdominguez
Docs: Update models and commands
6f8b019 
Updates models and commands to new format. Primarily:
- Streamline the lifecycle
- Better organize the semantic hierarchy
- Frontload concepts from start-to-finish (i.e., connect to data first, then your metadata, then business logic, and finally auth)
@robertjdominguez
Docs: Update relationships
e623e17
@robertjdominguez
Docs: Update permissions
418d7fe
@hasura-bot
Copy link
Collaborator

hasura-bot commented Jul 7, 2025 •
edited
Loading

Redirects 🔀

Hey, @robertjdominguez — the following redirects will be needed for deployment:

# TEST ME: https://stage.promptql.io/docs/data-modeling/_category_.json
location = /docs/data-modeling/_category_.json {
    return 301 https://$host/docs/OG-FILE-WAS-DELETED-REPLACE-ME-WITH-NEW-LOCATION;
}

# TEST ME: https://stage.promptql.io/docs/data-modeling/command/
location = /docs/data-modeling/command/ {
    return 301 https://$host/docs/OG-FILE-WAS-DELETED-REPLACE-ME-WITH-NEW-LOCATION;
}

# TEST ME: https://stage.promptql.io/docs/data-modeling/data-modeling-workflows/
location = /docs/data-modeling/data-modeling-workflows/ {
    return 301 https://$host/docs/OG-FILE-WAS-DELETED-REPLACE-ME-WITH-NEW-LOCATION;
}

# TEST ME: https://stage.promptql.io/docs/data-modeling/index/
location = /docs/data-modeling/index/ {
    return 301 https://$host/docs/OG-FILE-WAS-DELETED-REPLACE-ME-WITH-NEW-LOCATION;
}

# TEST ME: https://stage.promptql.io/docs/data-modeling/model/
location = /docs/data-modeling/model/ {
    return 301 https://$host/docs/OG-FILE-WAS-DELETED-REPLACE-ME-WITH-NEW-LOCATION;
}

# TEST ME: https://stage.promptql.io/docs/data-modeling/relationship/
location = /docs/data-modeling/relationship/ {
    return 301 https://$host/docs/OG-FILE-WAS-DELETED-REPLACE-ME-WITH-NEW-LOCATION;
}

# TEST ME: https://stage.promptql.io/docs/data-modeling/semantic-information/
location = /docs/data-modeling/semantic-information/ {
    return 301 https://$host/docs/OG-FILE-WAS-DELETED-REPLACE-ME-WITH-NEW-LOCATION;
}

# TEST ME: https://stage.promptql.io/docs/how-to-build-with-promptql/_boilerplateDx/
location = /docs/how-to-build-with-promptql/_boilerplateDx/ {
    return 301 https://$host/docs/OG-FILE-WAS-DELETED-REPLACE-ME-WITH-NEW-LOCATION;
}

# TEST ME: https://stage.promptql.io/docs/data-modeling/iterate/
location = /docs/data-modeling/iterate/ {
    return 301 https://$host/docs/metadata/guides/iterate/;
}

# TEST ME: https://stage.promptql.io/docs/data-modeling/typecasting/
location = /docs/data-modeling/typecasting/ {
    return 301 https://$host/docs/metadata/guides/typecasting/;
}

# TEST ME: https://stage.promptql.io/docs/data-modeling/partials/classic-connectors/clickHouse/_command-create-native-operation-how-to/
location = /docs/data-modeling/partials/classic-connectors/clickHouse/_command-create-native-operation-how-to/ {
    return 301 https://$host/docs/metadata/partials/classic-connectors/clickHouse/_command-create-native-operation-how-to/;
}

# TEST ME: https://stage.promptql.io/docs/data-modeling/partials/classic-connectors/clickHouse/_model-create-native-query-how-to/
location = /docs/data-modeling/partials/classic-connectors/clickHouse/_model-create-native-query-how-to/ {
    return 301 https://$host/docs/metadata/partials/classic-connectors/clickHouse/_model-create-native-query-how-to/;
}

# TEST ME: https://stage.promptql.io/docs/data-modeling/partials/classic-connectors/clickHouse/_model-create-native-query-tutorial/
location = /docs/data-modeling/partials/classic-connectors/clickHouse/_model-create-native-query-tutorial/ {
    return 301 https://$host/docs/metadata/partials/classic-connectors/clickHouse/_model-create-native-query-tutorial/;
}

# TEST ME: https://stage.promptql.io/docs/data-modeling/partials/classic-connectors/clickHouse/_model-create-tutorial/
location = /docs/data-modeling/partials/classic-connectors/clickHouse/_model-create-tutorial/ {
    return 301 https://$host/docs/metadata/partials/classic-connectors/clickHouse/_model-create-tutorial/;
}

# TEST ME: https://stage.promptql.io/docs/data-modeling/partials/classic-connectors/clickHouse/_relationship-create-model-to-model/
location = /docs/data-modeling/partials/classic-connectors/clickHouse/_relationship-create-model-to-model/ {
    return 301 https://$host/docs/metadata/partials/classic-connectors/clickHouse/_relationship-create-model-to-model/;
}

# TEST ME: https://stage.promptql.io/docs/data-modeling/partials/classic-connectors/mongoDB/_command-create-native-operation-how-to/
location = /docs/data-modeling/partials/classic-connectors/mongoDB/_command-create-native-operation-how-to/ {
    return 301 https://$host/docs/metadata/partials/classic-connectors/mongoDB/_command-create-native-operation-how-to/;
}

# TEST ME: https://stage.promptql.io/docs/data-modeling/partials/classic-connectors/mongoDB/_command-create-native-operation-tutorial/
location = /docs/data-modeling/partials/classic-connectors/mongoDB/_command-create-native-operation-tutorial/ {
    return 301 https://$host/docs/metadata/partials/classic-connectors/mongoDB/_command-create-native-operation-tutorial/;
}

# TEST ME: https://stage.promptql.io/docs/data-modeling/partials/classic-connectors/mongoDB/_command-create-tutorial/
location = /docs/data-modeling/partials/classic-connectors/mongoDB/_command-create-tutorial/ {
    return 301 https://$host/docs/metadata/partials/classic-connectors/mongoDB/_command-create-tutorial/;
}

# TEST ME: https://stage.promptql.io/docs/data-modeling/partials/classic-connectors/mongoDB/_command-update-tutorial/
location = /docs/data-modeling/partials/classic-connectors/mongoDB/_command-update-tutorial/ {
    return 301 https://$host/docs/metadata/partials/classic-connectors/mongoDB/_command-update-tutorial/;
}

# TEST ME: https://stage.promptql.io/docs/data-modeling/partials/classic-connectors/mongoDB/_model-create-native-query-how-to/
location = /docs/data-modeling/partials/classic-connectors/mongoDB/_model-create-native-query-how-to/ {
    return 301 https://$host/docs/metadata/partials/classic-connectors/mongoDB/_model-create-native-query-how-to/;
}

# TEST ME: https://stage.promptql.io/docs/data-modeling/partials/classic-connectors/mongoDB/_model-create-native-query-tutorial/
location = /docs/data-modeling/partials/classic-connectors/mongoDB/_model-create-native-query-tutorial/ {
    return 301 https://$host/docs/metadata/partials/classic-connectors/mongoDB/_model-create-native-query-tutorial/;
}

# TEST ME: https://stage.promptql.io/docs/data-modeling/partials/classic-connectors/mongoDB/_model-create-tutorial/
location = /docs/data-modeling/partials/classic-connectors/mongoDB/_model-create-tutorial/ {
    return 301 https://$host/docs/metadata/partials/classic-connectors/mongoDB/_model-create-tutorial/;
}

# TEST ME: https://stage.promptql.io/docs/data-modeling/partials/classic-connectors/mongoDB/_relationship-create-model-to-model/
location = /docs/data-modeling/partials/classic-connectors/mongoDB/_relationship-create-model-to-model/ {
    return 301 https://$host/docs/metadata/partials/classic-connectors/mongoDB/_relationship-create-model-to-model/;
}

# TEST ME: https://stage.promptql.io/docs/data-modeling/partials/classic-connectors/postgreSQL/_command-create-native-operation-how-to/
location = /docs/data-modeling/partials/classic-connectors/postgreSQL/_command-create-native-operation-how-to/ {
    return 301 https://$host/docs/metadata/partials/classic-connectors/postgreSQL/_command-create-native-operation-how-to/;
}

# TEST ME: https://stage.promptql.io/docs/data-modeling/partials/classic-connectors/postgreSQL/_command-create-native-operation-tutorial/
location = /docs/data-modeling/partials/classic-connectors/postgreSQL/_command-create-native-operation-tutorial/ {
    return 301 https://$host/docs/metadata/partials/classic-connectors/postgreSQL/_command-create-native-operation-tutorial/;
}

# TEST ME: https://stage.promptql.io/docs/data-modeling/partials/classic-connectors/postgreSQL/_command-create-tutorial/
location = /docs/data-modeling/partials/classic-connectors/postgreSQL/_command-create-tutorial/ {
    return 301 https://$host/docs/metadata/partials/classic-connectors/postgreSQL/_command-create-tutorial/;
}

# TEST ME: https://stage.promptql.io/docs/data-modeling/partials/classic-connectors/postgreSQL/_command-update-tutorial/
location = /docs/data-modeling/partials/classic-connectors/postgreSQL/_command-update-tutorial/ {
    return 301 https://$host/docs/metadata/partials/classic-connectors/postgreSQL/_command-update-tutorial/;
}

# TEST ME: https://stage.promptql.io/docs/data-modeling/partials/classic-connectors/postgreSQL/_model-create-native-query-how-to/
location = /docs/data-modeling/partials/classic-connectors/postgreSQL/_model-create-native-query-how-to/ {
    return 301 https://$host/docs/metadata/partials/classic-connectors/postgreSQL/_model-create-native-query-how-to/;
}

# TEST ME: https://stage.promptql.io/docs/data-modeling/partials/classic-connectors/postgreSQL/_model-create-native-query-tutorial/
location = /docs/data-modeling/partials/classic-connectors/postgreSQL/_model-create-native-query-tutorial/ {
    return 301 https://$host/docs/metadata/partials/classic-connectors/postgreSQL/_model-create-native-query-tutorial/;
}

# TEST ME: https://stage.promptql.io/docs/data-modeling/partials/classic-connectors/postgreSQL/_model-create-tutorial/
location = /docs/data-modeling/partials/classic-connectors/postgreSQL/_model-create-tutorial/ {
    return 301 https://$host/docs/metadata/partials/classic-connectors/postgreSQL/_model-create-tutorial/;
}

# TEST ME: https://stage.promptql.io/docs/data-modeling/partials/classic-connectors/postgreSQL/_relationship-create-model-to-model/
location = /docs/data-modeling/partials/classic-connectors/postgreSQL/_relationship-create-model-to-model/ {
    return 301 https://$host/docs/metadata/partials/classic-connectors/postgreSQL/_relationship-create-model-to-model/;
}

# TEST ME: https://stage.promptql.io/docs/data-modeling/partials/lambda-connectors/go/_command-create-native-operation-how-to/
location = /docs/data-modeling/partials/lambda-connectors/go/_command-create-native-operation-how-to/ {
    return 301 https://$host/docs/metadata/partials/lambda-connectors/go/_command-create-native-operation-how-to/;
}

# TEST ME: https://stage.promptql.io/docs/data-modeling/partials/lambda-connectors/go/_command-create-tutorial/
location = /docs/data-modeling/partials/lambda-connectors/go/_command-create-tutorial/ {
    return 301 https://$host/docs/metadata/partials/lambda-connectors/go/_command-create-tutorial/;
}

# TEST ME: https://stage.promptql.io/docs/data-modeling/partials/lambda-connectors/go/_command-update-tutorial/
location = /docs/data-modeling/partials/lambda-connectors/go/_command-update-tutorial/ {
    return 301 https://$host/docs/metadata/partials/lambda-connectors/go/_command-update-tutorial/;
}

# TEST ME: https://stage.promptql.io/docs/data-modeling/partials/lambda-connectors/python/_command-create-native-operation-how-to/
location = /docs/data-modeling/partials/lambda-connectors/python/_command-create-native-operation-how-to/ {
    return 301 https://$host/docs/metadata/partials/lambda-connectors/python/_command-create-native-operation-how-to/;
}

# TEST ME: https://stage.promptql.io/docs/data-modeling/partials/lambda-connectors/python/_command-create-tutorial/
location = /docs/data-modeling/partials/lambda-connectors/python/_command-create-tutorial/ {
    return 301 https://$host/docs/metadata/partials/lambda-connectors/python/_command-create-tutorial/;
}

# TEST ME: https://stage.promptql.io/docs/data-modeling/partials/lambda-connectors/python/_command-update-tutorial/
location = /docs/data-modeling/partials/lambda-connectors/python/_command-update-tutorial/ {
    return 301 https://$host/docs/metadata/partials/lambda-connectors/python/_command-update-tutorial/;
}

# TEST ME: https://stage.promptql.io/docs/data-modeling/partials/lambda-connectors/typescript/_command-create-native-operation-how-to/
location = /docs/data-modeling/partials/lambda-connectors/typescript/_command-create-native-operation-how-to/ {
    return 301 https://$host/docs/metadata/partials/lambda-connectors/typescript/_command-create-native-operation-how-to/;
}

# TEST ME: https://stage.promptql.io/docs/data-modeling/partials/lambda-connectors/typescript/_command-create-tutorial/
location = /docs/data-modeling/partials/lambda-connectors/typescript/_command-create-tutorial/ {
    return 301 https://$host/docs/metadata/partials/lambda-connectors/typescript/_command-create-tutorial/;
}

# TEST ME: https://stage.promptql.io/docs/data-modeling/partials/lambda-connectors/typescript/_command-update-tutorial/
location = /docs/data-modeling/partials/lambda-connectors/typescript/_command-update-tutorial/ {
    return 301 https://$host/docs/metadata/partials/lambda-connectors/typescript/_command-update-tutorial/;
}

# TEST ME: https://stage.promptql.io/docs/data-modeling/permissions/
location = /docs/data-modeling/permissions/ {
    return 301 https://$host/docs/metadata/permissions/;
}

@hasura-bot
Copy link
Collaborator

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

@cloudflare-workers-and-pages Cloudflare Workers and Pages
Copy link

Deploying promptql-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: 418d7fe
Status: ✅  Deploy successful!
Preview URL: https://57ca73b6.promptql-docs.pages.dev
Branch Preview URL: https://robdominguez-doc-2909-turn-d.promptql-docs.pages.dev

View logs

@robertjdominguez robertjdominguez merged commit 7cd2286 into main Jul 8, 2025
3 checks passed
@robertjdominguez robertjdominguez deleted the robdominguez/doc-2909-turn-data-modeling-into-semantic-metadataunder-core-concepts branch July 8, 2025 14:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@robertjdominguez @hasura-bot