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

Comprehensive documentation improvements #4031

Merged
merged 33 commits into from
Jan 8, 2025
Merged
Show file tree
Hide file tree
Changes from 16 commits
Commits
Show all changes
33 commits
Select commit Hold shift + click to select a range
012ef3b
Improve Database Settings UI
seancolsen Nov 19, 2024
0b97227
Use "Privileges" terminology in UI
seancolsen Nov 20, 2024
cb8fd8f
Improve UI in References inspector section
seancolsen Nov 26, 2024
4c733e6
Adjust DB help text for inspector section headers
seancolsen Nov 26, 2024
c8afbf2
Trim child margins within all tooltips
seancolsen Nov 26, 2024
9c1056b
Add help to References inspector section
seancolsen Nov 26, 2024
185d032
Polish copy for relationships section and modal
seancolsen Nov 26, 2024
7f5dba0
Polish some copy in data explorer
seancolsen Nov 26, 2024
3c6b727
Improve type safety for DocsLinks component
seancolsen Nov 27, 2024
89063b8
Minor copy fixes
seancolsen Nov 27, 2024
808a2b4
Fix docs link to moved page
seancolsen Nov 27, 2024
54fd084
Add help bubbles in db settings UI
seancolsen Nov 27, 2024
e788775
Fix spelling errors in UI strings
seancolsen Dec 3, 2024
b261740
Help bubbles and UI string updates
seancolsen Dec 3, 2024
2d9c64e
Docs: overhaul user docs
seancolsen Dec 3, 2024
6d9e6c8
Run Prettier
seancolsen Dec 3, 2024
8901acb
Merge branch 'develop' into beta_user_docs
seancolsen Dec 4, 2024
da61a98
Remove empty lines
seancolsen Dec 4, 2024
4911484
Docs: content adjustments via pairing session
seancolsen Dec 11, 2024
ed5d39d
Docs: Tighten upgrade language
seancolsen Dec 11, 2024
8460215
Docs: Add "Upgrade" page
seancolsen Dec 11, 2024
e7c0df9
Docs: Tighten API docs warning language
seancolsen Dec 11, 2024
6a88b85
Docs: add question mark
seancolsen Dec 11, 2024
dc64148
Docs: tighten language
seancolsen Dec 11, 2024
33b6c16
Docs: add question mark
seancolsen Dec 11, 2024
5c62ab3
Docs: add question mark
seancolsen Dec 11, 2024
198ecff
Merge branch 'develop' into beta_user_docs
seancolsen Dec 11, 2024
032300e
Merge branch 'develop' into beta_user_docs
seancolsen Jan 3, 2025
e3a4464
Merge branch 'develop' into beta_user_docs
seancolsen Jan 6, 2025
02ab36d
Address PR suggestions
zackkrida Jan 7, 2025
5d31923
Merge branch 'develop' into beta_user_docs
zackkrida Jan 7, 2025
aa1fc6c
Modest changes to the databases guide page
zackkrida Jan 7, 2025
2a1f0b3
Merge remote-tracking branch 'refs/remotes/origin/beta_user_docs' int…
zackkrida Jan 7, 2025
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
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 -->
seancolsen marked this conversation as resolved.
Show resolved Hide resolved
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.
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
Loading