From 44b7f26457e4938bb757a32312ab436bc0138d32 Mon Sep 17 00:00:00 2001 From: Sean Colsen Date: Tue, 16 Jan 2024 19:52:32 -0500 Subject: [PATCH] Begin adding conceptual overview content This reverts commit 9af8d75d8a7e0b6a10148d63b1027b96917758e7. --- docs/docs/concepts.md | 20 ++++++++++++++++++++ docs/docs/index.md | 2 ++ docs/mkdocs.yml | 1 + 3 files changed, 23 insertions(+) create mode 100644 docs/docs/concepts.md diff --git a/docs/docs/concepts.md b/docs/docs/concepts.md new file mode 100644 index 0000000000..a9f1e90076 --- /dev/null +++ b/docs/docs/concepts.md @@ -0,0 +1,20 @@ +# Conceptual overview + + + +Mathesar provides a spreadsheet-like interface to a PostgreSQL database. Mathesar works by connection to an Postgres server using a database credentials with appropriate [permissions](#permissions) provided by you, inferring the database structure by reading through the [catalog tables](https://www.postgresql.org/docs/current/catalogs.html) which we call as reflection and presenting the reflected data in a easy to use UI. We also help the user modify, perform SQL operations using the UI by converting the actions done using to equivalent SQL command and running it on the Postgres database. + +## PostgreSQL permissions {:#permissions} + +## Mathesar schemas {:#schemas} + +## Reflection {:#reflection} diff --git a/docs/docs/index.md b/docs/docs/index.md index c0d72c7024..812c306de6 100644 --- a/docs/docs/index.md +++ b/docs/docs/index.md @@ -4,6 +4,8 @@ Mathesar is a self-hostable open source project that provides a spreadsheet-like interface to a PostgreSQL database. Our web-based interface helps you and your collaborators set up data models, edit data, and build custom reports — no technical skills needed. You can create a new PostgreSQL database while setting up Mathesar or use our UI to interact with an existing database (or do both). +See our [conceptual overview](./concepts.md) to learn more about the inner workings of Mathesar. + ## Try Mathesar Try our [live demo](https://demo.mathesar.org/) to try out Mathesar online. diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index 187a690b0b..c40c8b6e61 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -6,6 +6,7 @@ repo_name: centerofci/mathesar nav: - Introduction: - Welcome: index.md + - Conceptual Overview: concepts.md - Installation: - Install using Docker image: installation/docker/index.md - Install using Docker Compose: installation/docker-compose/index.md