Skip to content

Commit

Permalink
Merge pull request #4031 from mathesar-foundation/beta_user_docs
Browse files Browse the repository at this point in the history
Comprehensive documentation improvements
  • Loading branch information
seancolsen authored Jan 8, 2025
2 parents 1f69b0a + 2a1f0b3 commit af1e1a1
Show file tree
Hide file tree
Showing 94 changed files with 2,278 additions and 1,269 deletions.
3 changes: 3 additions & 0 deletions docs/docs/administration/backup-restore.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Backup & Restore

<!-- TODO -->
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Environment Variables
# Configuring Mathesar with environment variables

This page contains all available environment variables supported by Mathesar. See the specific installation guides for the applicable environment variables and instructions on how to set them.

Expand Down Expand Up @@ -51,7 +51,7 @@ This page contains all available environment variables supported by Mathesar. Se
## Caddy reverse proxy configuration {: #caddy}
!!!note
These variables are only needed if you're using the Caddy configuration in our [default Docker Compose](../../installation/docker-compose/#steps) file.
These variables are only needed if you're using the Caddy configuration in our [default Docker Compose](install-via-docker-compose.md#steps) file.
### `DOMAIN_NAME`
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,4 @@
# Install Mathesar from source on Linux

!!! danger "Not a stable release"
This is a testing build released with the goal of gathering feedback from our community. It has **[many known issues](https://github.com/mathesar-foundation/mathesar/issues?q=is%3Aissue+milestone%3Av0.2.0-testing.2+)** and is not recommended for production use.
# Install Mathesar From Scratch on Linux

!!! warning "For experienced Linux sysadmins"
To follow this guide you need be experienced with Linux server administration, including the command line interface and some common utilities.
Expand Down Expand Up @@ -176,7 +173,7 @@ Then press <kbd>Enter</kbd> to customize this guide with your domain name.
touch .env
```
1. Edit your `.env` file, adding [environment variables](../../configuration/env-variables.md) to configure Mathesar.
1. Edit your `.env` file, adding [environment variables](./configuration.md) to configure Mathesar.
!!! example
Your `.env` file should look something like this
Expand All @@ -193,7 +190,7 @@ Then press <kbd>Enter</kbd> to customize this guide with your domain name.
```
!!! tip
To generate a [`SECRET_KEY`](../../configuration/env-variables.md#secret_key) you can use this [browser-based generator](https://djecrety.ir/) or run this command on MacOS or Linux:
To generate a [`SECRET_KEY`](./configuration.md#secret_key) you can use this [browser-based generator](https://djecrety.ir/) or run this command on MacOS or Linux:
```
echo $(cat /dev/urandom | LC_CTYPE=C tr -dc 'a-zA-Z0-9' | head -c 50)
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,5 @@
# Install Mathesar via Docker Compose

!!! danger "Not a stable release"
This is a testing build released with the goal of gathering feedback from our community. It has **[many known issues](https://github.com/mathesar-foundation/mathesar/issues?q=is%3Aissue+milestone%3Av0.2.0-testing.2+)** and is not recommended for production use.

## Prerequisites

{% include 'snippets/docker-compose-prerequisites.md' %}
Expand Down Expand Up @@ -119,4 +116,4 @@ If you'd like to use an external PostgreSQL server for Mathesar's internal datab
psql -c 'create database mathesar_django;'
```
1. Configure the [internal database environment variables](../../configuration/env-variables.md#db) to point to the database you just created. Ensure that you change the default values for the user, password, and host.
1. Configure the [internal database environment variables](./configuration.md#db) to point to the database you just created. Ensure that you change the default values for the user, password, and host.
9 changes: 9 additions & 0 deletions docs/docs/administration/upgrade.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Upgrade Mathesar

The steps to upgrade Mathesar vary by release.

1. First find the release notes for the version to which you'd like to upgrade.
1. Look at the bottom of the release notes for upgrade instructions.

!!! warning "Caveats"
- Upgrading to Mathesar 0.2.0 from prior versions is not supported. You'll need to reinstall Mathesar to use this version.
207 changes: 0 additions & 207 deletions docs/docs/administration/upgrade/0.1.4.md

This file was deleted.

17 changes: 0 additions & 17 deletions docs/docs/administration/upgrade/0.1.5.md

This file was deleted.

86 changes: 0 additions & 86 deletions docs/docs/administration/upgrade/0.1.6.md

This file was deleted.

Loading

0 comments on commit af1e1a1

Please sign in to comment.