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

Version 0.1.4 #3422

Merged
merged 84 commits into from
Jan 30, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
84 commits
Select commit Hold shift + click to select a range
c135bf1
Add deprecation warning to docker-compose install guide
silentninja Sep 21, 2023
867f6b3
Add warning for deprecating docker-compose
silentninja Sep 21, 2023
10a2d7b
Update warning for deprecating docker-compose
silentninja Sep 21, 2023
e0ccc9e
Merge branch 'docker-docs' into debian-docs
silentninja Sep 22, 2023
b78588c
Add debian installation instructions
silentninja Sep 24, 2023
433c8b2
Update debian docs to download the deb file.
silentninja Sep 27, 2023
92efcf6
Merge branch 'develop' into debian-docs
silentninja Oct 4, 2023
1218435
Merge remote-tracking branch 'origin/debian-docs' into debian-docs
silentninja Oct 4, 2023
d45f5f0
Clean up Debian installation docs
silentninja Oct 4, 2023
b245094
Add debian install to docs navigation
silentninja Oct 5, 2023
49fd6bc
Merge branch 'develop' into deprecate-old-docs
silentninja Oct 6, 2023
226a6c3
WIP changes made over pairing session
seancolsen Oct 6, 2023
2fb0006
Point to correct Debian repo url
silentninja Oct 18, 2023
d81942c
Add concepts page
silentninja Oct 19, 2023
3531f2a
Some docs tweaks during a call
seancolsen Oct 19, 2023
fbc18d0
Merge branch 'develop' into deprecate-old-docs
silentninja Oct 31, 2023
15fd32c
merge develop while fixing conflicts
Anish9901 Nov 30, 2023
7b83f56
Merge branch 'develop' into deprecate-old-docs
Anish9901 Nov 30, 2023
536c2ee
remove debian docs
Anish9901 Nov 30, 2023
d2d2feb
reconcile docker-compose installation docs
Anish9901 Nov 30, 2023
a11eb4a
fix commands & refactoring install docs for docker compose
Anish9901 Dec 1, 2023
702556c
reconciled docker compose installation docs
Anish9901 Dec 4, 2023
0494eb7
restore guided-install & scratch install and mark as deprecated
Anish9901 Dec 4, 2023
fb2a0ca
add deprecated warnings for guided and source install
Anish9901 Dec 4, 2023
a254021
rm upgrade using ui section
Anish9901 Dec 4, 2023
2b3e643
add link for docker compose install in the welcome page
Anish9901 Dec 4, 2023
ca0804a
Merge branch 'develop' into deprecate-old-docs
mathemancer Jan 2, 2024
ce62675
update env variables to reflect the current state
Anish9901 Jan 8, 2024
9a532f3
Merge branch 'develop' into deprecate-old-docs
Anish9901 Jan 8, 2024
360c861
Add front-page quick start instructions
mathemancer Jan 9, 2024
6b8dfb1
Fix weird highlighting, improve copy
mathemancer Jan 9, 2024
fa870ab
replace mentions of DJANGO_DATABASE_URL with Internal db env vars, up…
Anish9901 Jan 9, 2024
f919ea3
document steps to upgrade and uninstall
Anish9901 Jan 9, 2024
a3f1892
Create try out section, switch headers to imperative
mathemancer Jan 11, 2024
ed8b27a
improve formatting and highlighting of docker installation page
mathemancer Jan 11, 2024
db6fe0b
remove guided installation script, documentation
mathemancer Jan 15, 2024
b8bd95d
remove deprecation labels on source installation
mathemancer Jan 15, 2024
a524e7d
Merge branch 'develop' into deprecate-old-docs
mathemancer Jan 15, 2024
9af8d75
Temporarily remove conceptual overview content
seancolsen Jan 17, 2024
4982dbd
Add info about using sudo, add method reference
mathemancer Jan 17, 2024
32d1eb0
Update bare metal installation docs
mathemancer Jan 17, 2024
f996fd9
Merge branch '0.1.4' into deprecate-old-docs
seancolsen Jan 19, 2024
92151ea
Tighten up duplicate "Prerequisites" content
seancolsen Jan 19, 2024
c9af215
Merge branch '0.1.4' into deprecate-old-docs
seancolsen Jan 23, 2024
5ced013
Import 0.1.4 release notes content from HackMD
seancolsen Jan 23, 2024
b9bb4c2
Update PR links in release notes to follow prev fmt
seancolsen Jan 23, 2024
99c3383
document reduced privilege new feature
mathemancer Jan 23, 2024
8751643
Document unified docker image for release
mathemancer Jan 23, 2024
90df3a0
document postgres version support
mathemancer Jan 23, 2024
fe5e4ca
document SQLite support, bugfixes
mathemancer Jan 23, 2024
0f2dfc8
save progress to switch tasks for a bit
mathemancer Jan 23, 2024
750ed90
Improve Docker image installation docs
seancolsen Jan 24, 2024
aea734b
checkpoint on docs at backing up setup
mathemancer Jan 25, 2024
84a2f67
Finish upgrade docs for docker compose
mathemancer Jan 25, 2024
97bf368
Move Docker image from "install" to "try"
seancolsen Jan 25, 2024
bfd3c1d
Minor language adjustment
seancolsen Jan 25, 2024
fd17f86
Small "how to" addition
seancolsen Jan 25, 2024
f4b98ef
direct build-from-scratch users to update variables
mathemancer Jan 26, 2024
65d5951
restructure: move upgrade from release notes to admin
mathemancer Jan 26, 2024
3ea2fb9
link to upgrade instructions, tidy formatting
mathemancer Jan 26, 2024
874eed6
link to upgrade from dc installation
mathemancer Jan 26, 2024
bba4d26
remove upgrade link from installation.
mathemancer Jan 26, 2024
087e37b
tidy up docker compose install section, remove sudo
mathemancer Jan 26, 2024
40ff58b
Fill in remaining info for release PRs
mathemancer Jan 26, 2024
04b8210
remove empty snippet
mathemancer Jan 26, 2024
7eedfaa
remove unneeded sudo from source uninstallation guide
mathemancer Jan 26, 2024
049d075
remove defective highlighting, sudo
mathemancer Jan 26, 2024
e5adb93
document method for logging into unified image DB
mathemancer Jan 26, 2024
b060efe
Remove unneeded sudo reference
mathemancer Jan 26, 2024
88c14e7
fix bugs in documentation
mathemancer Jan 29, 2024
41d871d
Small formatting fix
seancolsen Jan 29, 2024
e9b268a
Clean up tips for trying locally
seancolsen Jan 29, 2024
195f42b
Remove date from release notes
seancolsen Jan 29, 2024
63017fc
Update node and npm minimum versions
seancolsen Jan 29, 2024
bf13b3f
Improve disclaimer for build-from-scratch install
seancolsen Jan 29, 2024
9257170
Use one page per version of upgrade instructions
seancolsen Jan 29, 2024
babcf24
Polish upgrade instructions
seancolsen Jan 29, 2024
d73f8bc
Add disclaimer in "build from scratch" upgrade
seancolsen Jan 29, 2024
850bed6
Add general upgrade disclaimer
seancolsen Jan 29, 2024
912877d
Fix broken link
seancolsen Jan 29, 2024
6f1e3db
Polish SECRET_KEY related docs
seancolsen Jan 29, 2024
f237112
Merge pull request #3227 from mathesar-foundation/deprecate-old-docs
seancolsen Jan 29, 2024
469be9f
Add release notes helper script
seancolsen Jan 29, 2024
326a773
Merge pull request #3427 from mathesar-foundation/release_notes_helper
seancolsen Jan 29, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Add concepts page
  • Loading branch information
silentninja committed Oct 19, 2023
commit d81942c0c9c3fdbb179bf0a7883840ffd5dddd61
3 changes: 3 additions & 0 deletions docs/docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,9 @@ You can create a new PostgreSQL database while setting up Mathesar or use our UI

A live demo of Mathesar is [available here](https://demo.mathesar.org/).

<!-- TODO: Add the advantage of reading the concept page -->
More about how Mathesar works is covered in the [Concepts page](./user-guide/concepts.md).

## Installing Mathesar
You can self-host Mathesar by following one of the guides below:

Expand Down
4 changes: 2 additions & 2 deletions docs/docs/installation/debian/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ You should have permission to install a debian package

## Installation Steps

<!-- TODO: remove mmukesh95, improve formatting of code block -->
<!-- TODO: replace with correct repo URL once assiged by OpenSuse, improve formatting of code block -->

1. Add keys to apt repository.

Expand Down Expand Up @@ -162,4 +162,4 @@ sudo apt upgrade mathesar

### 400 Bad request

If you are getting `400 (Bad request)` when visting Mathesar using a domain name or an IP address, it might be happening due to the domain name not whitelisted correctly. Please follow the instructions for [accessing using a domain name](#configuration).a
If you are getting `400 (Bad request)` when visting Mathesar using a domain name or an IP address, it might be happening due to the domain name not whitelisted correctly. Please follow the instructions for [accessing using a domain name](#configuration).
9 changes: 9 additions & 0 deletions docs/docs/user-guide/concepts.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# 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 datbase 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}
Loading