From 2ad6a952c27632409305839f77fd0fc36222234c Mon Sep 17 00:00:00 2001 From: Sean Colsen Date: Tue, 20 Feb 2024 16:33:01 -0500 Subject: [PATCH 01/21] Handle no cache dir in release notes helper script --- docs/docs/releases/find_missing_prs.sh | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/docs/docs/releases/find_missing_prs.sh b/docs/docs/releases/find_missing_prs.sh index 851942f8fd..2ee3e82c02 100755 --- a/docs/docs/releases/find_missing_prs.sh +++ b/docs/docs/releases/find_missing_prs.sh @@ -48,9 +48,10 @@ fi PREV_NOTES_FILE=$(ls -1 | sort | grep -B 1 $NOTES_FILE | head -n 1) PREV_RELEASE=$(echo $PREV_NOTES_FILE | sed s/.md$//) -COMMITS_FILE=cache/commits.txt -ALL_PRS_FILE=cache/all_prs.json -INCLUDED_PRS_FILE=cache/included_prs.txt +CACHE_DIR=cache +COMMITS_FILE="$CACHE_DIR/commits.txt" +ALL_PRS_FILE="$CACHE_DIR/all_prs.json" +INCLUDED_PRS_FILE="$CACHE_DIR/included_prs.txt" MISSING_PRS_FILE=missing_prs.csv # Use the latest release notes file @@ -72,6 +73,8 @@ RELEASE_BRANCH=$( fi ) +mkdir -p "$CACHE_DIR" + # Find and cache the hashes for all the PR-merge commits included in the release # branch but not included in the master branch. git log --format=%H --first-parent $PREV_RELEASE..$RELEASE_BRANCH > $COMMITS_FILE From 76a48c91353e3151123f6d7872091b3282c743aa Mon Sep 17 00:00:00 2001 From: Sean Colsen Date: Tue, 20 Feb 2024 16:46:31 -0500 Subject: [PATCH 02/21] Begin 0.1.5 release notes --- docs/docs/releases/0.1.5.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) create mode 100644 docs/docs/releases/0.1.5.md diff --git a/docs/docs/releases/0.1.5.md b/docs/docs/releases/0.1.5.md new file mode 100644 index 0000000000..137aa77560 --- /dev/null +++ b/docs/docs/releases/0.1.5.md @@ -0,0 +1,25 @@ +# Mathesar 0.1.5 + +## Upgrading to Mathesar 0.1.5 + +TODO + +## Documentation + +- Embedded video walkthrough within installation steps _[#3437](https://github.com/mathesar-foundation/mathesar/pull/3437 "Merge pull request #3436 from mathesar-foundation/video_walkthrough")_ _[#3443](https://github.com/mathesar-foundation/mathesar/pull/3443 "Merge pull request #3442 from mathesar-foundation/update_video_link")_ + +## Bug fixes + +- Fix active cell displaying above row header cell _[#3382](https://github.com/mathesar-foundation/mathesar/pull/3382 "Fix active cell displaying above row header cell")_ + +## Maintenance + +- Improve our release notes helper script _[#3435](https://github.com/mathesar-foundation/mathesar/pull/3435 "Merge pull request #3434 from mathesar-foundation/release_notes")_ +- Post-release cleanup _[#3432](https://github.com/mathesar-foundation/mathesar/pull/3432 "Merge pull request #3429 from mathesar-foundation/0.1.4")_ + + + + + + + From 891557d0c3097c83aac33c56c9d335b5a643002c Mon Sep 17 00:00:00 2001 From: Kriti Godey Date: Mon, 26 Feb 2024 14:55:33 -0500 Subject: [PATCH 03/21] Removed connecting to existing DB docs, minor updates to index --- .../configuration/connect-to-existing-db.md | 90 ------------------- docs/docs/index.md | 6 +- docs/mkdocs.yml | 1 - 3 files changed, 3 insertions(+), 94 deletions(-) delete mode 100644 docs/docs/configuration/connect-to-existing-db.md diff --git a/docs/docs/configuration/connect-to-existing-db.md b/docs/docs/configuration/connect-to-existing-db.md deleted file mode 100644 index 4bd27f7631..0000000000 --- a/docs/docs/configuration/connect-to-existing-db.md +++ /dev/null @@ -1,90 +0,0 @@ -# Connect to an external database server - -1. On the existing database server, [create a new database](https://www.postgresql.org/docs/current/sql-createdatabase.html) for Mathesar to store its metadata. - - ```bash - psql -c 'create database mathesar_django;' - ``` - -1. Configure the [Internal database environment variables](./env-variables.md#db) to point to the database you just created. - - -## Connect to a database server running on the host {: #localhost-db } - -!!! info "" - This content is related to Mathesar running in Docker related environments. - -If you're running Mathesar in a Docker related environment, and your database server runs on the host machine, you will not be able to connect to it using `localhost:`, since `localhost` would refer to the Docker environment and not to the host. - -You can try using `host.docker.internal` instead of `localhost`. Below are detailed instructions to expose the database on your host to the Docker instance. - -### Prerequisites - -1. Locate `postgresql.conf` & `pg_hba.conf` file on the host machine. This can be located using `psql` shell by executing the following respectively. - - ``` - SHOW config_file; - ``` - - and - - ``` - SHOW hba_file; - ``` -1. Create the necessary network bridges using docker-compose - - ``` - docker compose -f docker-compose.yml up service -d --no-start - ``` - -1. Find the appropriate IP addresses of the `docker0` interface and the `mathesar_default` interface. This can be found by exectuting the following in the host's terminal. - {% raw %} - ``` - docker network inspect -f "docker0 IP: {{range .IPAM.Config}}{{.Gateway}}{{end}}" bridge && docker network inspect -f "mathesar_default IP: {{range .IPAM.Config}}{{.Subnet}}{{end}}" mathesar_default - ``` - {% endraw %} - -1. Stop Mathesar if it's already running. - - -### Steps - -1. Edit the `postgresql.conf` file and add the IP of `docker0` interface in the `listen_addresses` setting. Uncomment this line if it's conmmented out. - - ``` - listen_addresses = 'localhost, ' - ``` - -1. Modify the `pg_hba.conf` file and grant access to the `mathesar_default` interface. Add the following line at the bottom of the file: - - ``` - host all all md5 - ``` - -1. Restart postgres: - - === "Linux" - ``` - systemctl restart postgresql - ``` - === "MacOS" - ``` - sudo brew services restart postgresql - ``` - -1. Set the value of [`MATHESAR_DATABASES` environment variable](./env-variables.md#mathesar_databases) to the following: - - ``` - MATHESAR_DATABASES=(|postgresql://:@host.docker.internal:/) - ``` - -1. If your Mathesar installation is Docker Compose based, add an extra host for the prod container in the `docker-compose.yml` file: - - ``` - extra_hosts: - - "host.docker.internal:" - ``` - -1. Start Mathesar. - -You should have a successful connection to the host database now! diff --git a/docs/docs/index.md b/docs/docs/index.md index debb152435..9b77bf0621 100644 --- a/docs/docs/index.md +++ b/docs/docs/index.md @@ -12,7 +12,7 @@ See our [live demo site](https://demo.mathesar.org/) to try Mathesar without ins ### Try locally -This is a quick way to play with Mathesar locally before installing, but will not be appropriate for saving data that you care about. +This is a quick way to play with Mathesar locally, but is not appropriate for saving data that you care about or setting up a long-term installation. 1. With [Docker](https://docs.docker.com/get-docker/) installed, run: @@ -51,8 +51,8 @@ You can self-host Mathesar by following one of the guides below: Mathesar should be pretty intuitive to use. More documentation is coming soon, but for now, we've written some documentation for some things that could be tricky. -- [Syncing Database Changes](./user-guide/syncing-db.md) -- [Users & Access Levels](./user-guide/users.md) +- [Syncing database changes](./user-guide/syncing-db.md) if the database's structure is changed outside of Mathesar. +- How to set up [users with different access levels](./user-guide/users.md) ## Contribute to Mathesar diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index 1212ea5fa6..d8f3d00b91 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -11,7 +11,6 @@ nav: - Install from scratch: installation/build-from-source/index.md - Configuration: - Environment variables: configuration/env-variables.md - - Connect to an existing database server: configuration/connect-to-existing-db.md - Administration: - Upgrade: - To 0.1.4: administration/upgrade/0.1.4.md From adc9e9e03c4088844caab5ff79de5a7e60a7645b Mon Sep 17 00:00:00 2001 From: Sean Colsen Date: Mon, 26 Feb 2024 18:24:22 -0500 Subject: [PATCH 04/21] Improve release notes helper script - Write missing PRs directly to release notes file - Include hover text with PR titles --- docs/docs/releases/README.md | 4 ++-- docs/docs/releases/find_missing_prs.sh | 28 +++++++++++++------------- 2 files changed, 16 insertions(+), 16 deletions(-) diff --git a/docs/docs/releases/README.md b/docs/docs/releases/README.md index 29a8e8c26e..762e51a6c4 100644 --- a/docs/docs/releases/README.md +++ b/docs/docs/releases/README.md @@ -14,9 +14,9 @@ This is developer documentation to help with release notes. It is not published - If you haven't yet created a release notes file for this release, it will create one for you. - The script will find PRs which have been merged but not yet included in the release notes file. -1. Open `missing_prs.csv` to see the PRs you need to add. Incorporate them into the release notes as you see fit. Save the release notes and commit them. +1. Open the release notes file and find a new section at the end titled **(TO CATEGORIZE)**. Incorporate PRs listed within this section into the release notes as you see fit. Rewrite the title text that appears directly in the markdown. Leave the titles as-written within the quotes (these will appear within hover text). Save the release notes and commit them. -1. Re-run the script as needed. When more PRs are merged, they will appear in `missing_prs.csv`. +1. Re-run the script as needed. ## How to format the release notes content diff --git a/docs/docs/releases/find_missing_prs.sh b/docs/docs/releases/find_missing_prs.sh index 2ee3e82c02..fb2ea0a7ee 100755 --- a/docs/docs/releases/find_missing_prs.sh +++ b/docs/docs/releases/find_missing_prs.sh @@ -52,7 +52,6 @@ CACHE_DIR=cache COMMITS_FILE="$CACHE_DIR/commits.txt" ALL_PRS_FILE="$CACHE_DIR/all_prs.json" INCLUDED_PRS_FILE="$CACHE_DIR/included_prs.txt" -MISSING_PRS_FILE=missing_prs.csv # Use the latest release notes file NOTES_FILE=$(ls -1 | grep -e '^[0-9]\.[0-9]\.[0-9]' | sort | tail -n 1) @@ -88,8 +87,6 @@ gh pr list \ --search "is:closed merged:>$(date -d '1 year ago' '+%Y-%m-%d')" \ --jq 'map({ additions: .additions, - author: .author.login, - deletions: .deletions, mergeCommit: .mergeCommit.oid, title: .title, url: .url @@ -102,14 +99,11 @@ grep -Po 'https://github\.com/mathesar-foundation/mathesar/pull/\d*' \ # Generate a CSV containing details for PRs that match commits in the release # but not in the release notes. -echo " +PR_LIST=$(echo " SELECT - pr.title, - pr.url, - pr.author, - pr.additions, - pr.deletions, - '[#' || regexp_extract(pr.url, '(\d+)$', 1) || '](' || pr.url || ')' AS link + '- ' || pr.title || + ' _[#' || regexp_extract(pr.url, '(\d+)$', 1) || ']' || + '(' || pr.url || ' \"' || replace(pr.title, '\"', '') || '\")_' AS link FROM read_json('$ALL_PRS_FILE', auto_detect=true) AS pr JOIN read_csv('$COMMITS_FILE', columns={'hash': 'text'}) AS commit ON commit.hash = pr.mergeCommit @@ -117,9 +111,15 @@ echo " ON included.url = pr.url WHERE included.url IS NULL ORDER BY pr.additions DESC;" | \ - duckdb -csv > $MISSING_PRS_FILE + duckdb -ascii -noheader -newline $'\n') -COUNT=$(tail -n +2 $MISSING_PRS_FILE | wc -l) - -echo "$COUNT missing PRs written to $MISSING_PRS_FILE" +if [ -z "$PR_LIST" ]; then + echo "No missing PRs" + exit 0 +fi +echo $'\n\n## (TO CATEGORIZE)\n' >> $NOTES_FILE +echo "$PR_LIST" >> $NOTES_FILE +echo $'\n' >> $NOTES_FILE +COUNT=$(wc -l <<< "$PR_LIST") +echo "$COUNT additional PRs written to $NOTES_FILE. Please categorize them." From 24e49bac8958d14a256c6775615ddd2df0d5f2a3 Mon Sep 17 00:00:00 2001 From: Sean Colsen Date: Mon, 26 Feb 2024 18:31:04 -0500 Subject: [PATCH 05/21] Add more PRs to release notes --- docs/docs/releases/0.1.5.md | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/docs/docs/releases/0.1.5.md b/docs/docs/releases/0.1.5.md index 137aa77560..e407ed38d5 100644 --- a/docs/docs/releases/0.1.5.md +++ b/docs/docs/releases/0.1.5.md @@ -4,12 +4,20 @@ TODO +## Features + +- Improve performance of loading sample data when adding a new connection _[#3448](https://github.com/mathesar-foundation/mathesar/pull/3448 "Efficient data loader")_ + ## Documentation - Embedded video walkthrough within installation steps _[#3437](https://github.com/mathesar-foundation/mathesar/pull/3437 "Merge pull request #3436 from mathesar-foundation/video_walkthrough")_ _[#3443](https://github.com/mathesar-foundation/mathesar/pull/3443 "Merge pull request #3442 from mathesar-foundation/update_video_link")_ ## Bug fixes +- Fix "Page not found" error when viewing a shared exploration _[#3456](https://github.com/mathesar-foundation/mathesar/pull/3456 "Fix regression where `connections` list is empty in `common_data`")_ +- Restore display of column type icons within shared tables _[#3456](https://github.com/mathesar-foundation/mathesar/pull/3456 "Fix regression where `connections` list is empty in `common_data`")_ +- Constrain the width of the connections page _[#3439](https://github.com/mathesar-foundation/mathesar/pull/3439 "Constrain the width of the connections page")_ +- Temporarily hide link to missing docs page _[#3451](https://github.com/mathesar-foundation/mathesar/pull/3451 "Temporarily hide link to missing docs page")_ - Fix active cell displaying above row header cell _[#3382](https://github.com/mathesar-foundation/mathesar/pull/3382 "Fix active cell displaying above row header cell")_ ## Maintenance @@ -17,9 +25,3 @@ TODO - Improve our release notes helper script _[#3435](https://github.com/mathesar-foundation/mathesar/pull/3435 "Merge pull request #3434 from mathesar-foundation/release_notes")_ - Post-release cleanup _[#3432](https://github.com/mathesar-foundation/mathesar/pull/3432 "Merge pull request #3429 from mathesar-foundation/0.1.4")_ - - - - - - From 7fb44d2c8be594b78312417c94d70a845f3b84a7 Mon Sep 17 00:00:00 2001 From: Sean Colsen Date: Mon, 26 Feb 2024 18:46:03 -0500 Subject: [PATCH 06/21] Guarantee that release notes are comprehensive --- docs/docs/releases/0.1.4.md | 2 ++ docs/docs/releases/0.1.5.md | 6 ++++++ 2 files changed, 8 insertions(+) diff --git a/docs/docs/releases/0.1.4.md b/docs/docs/releases/0.1.4.md index cbdd0c926f..d2f2854eb9 100644 --- a/docs/docs/releases/0.1.4.md +++ b/docs/docs/releases/0.1.4.md @@ -4,6 +4,8 @@ Mathesar 0.1.4 focuses on improving the installation and setup experience. +_This page provides a comprehensive list of all changes in the release._ + ## Upgrading to 0.1.4 See our guide on [upgrading Mathesar to 0.1.4](../administration/upgrade/0.1.4.md). diff --git a/docs/docs/releases/0.1.5.md b/docs/docs/releases/0.1.5.md index e407ed38d5..5439826ed9 100644 --- a/docs/docs/releases/0.1.5.md +++ b/docs/docs/releases/0.1.5.md @@ -1,5 +1,11 @@ # Mathesar 0.1.5 +## Summary + +Mathesar 0.1.4 is a small, bug fix release. + +_This page provides a comprehensive list of all changes in the release._ + ## Upgrading to Mathesar 0.1.5 TODO From 7e71388194d10e44d182ee84729b0127ecbe9db7 Mon Sep 17 00:00:00 2001 From: Sean Colsen Date: Mon, 26 Feb 2024 18:57:29 -0500 Subject: [PATCH 07/21] Use a template for new release notes files --- docs/docs/releases/README.md | 18 ------------- docs/docs/releases/TEMPLATE.md | 35 ++++++++++++++++++++++++++ docs/docs/releases/find_missing_prs.sh | 6 +++-- 3 files changed, 39 insertions(+), 20 deletions(-) create mode 100644 docs/docs/releases/TEMPLATE.md diff --git a/docs/docs/releases/README.md b/docs/docs/releases/README.md index 762e51a6c4..e1ad78a11b 100644 --- a/docs/docs/releases/README.md +++ b/docs/docs/releases/README.md @@ -18,21 +18,3 @@ This is developer documentation to help with release notes. It is not published 1. Re-run the script as needed. -## How to format the release notes content - -1. Group changes into sections in the following order - - ```md - ## Security fixes - ## Breaking changes - ## New features - ## Groundwork - ## Documentation - ## Bug fixes - ## Maintenance - ``` - - You can omit sections if there are no applicable changes. - -1. Within the "New features" section, further categorize changes by specific features using level 3 headings. - diff --git a/docs/docs/releases/TEMPLATE.md b/docs/docs/releases/TEMPLATE.md new file mode 100644 index 0000000000..19fe774434 --- /dev/null +++ b/docs/docs/releases/TEMPLATE.md @@ -0,0 +1,35 @@ +# Mathesar __VERSION__ + +## Summary + +TODO + +_This page provides a comprehensive list of all changes in the release._ + +## Upgrading to __VERSION__ + +TODO + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/docs/releases/find_missing_prs.sh b/docs/docs/releases/find_missing_prs.sh index fb2ea0a7ee..61fda834b6 100755 --- a/docs/docs/releases/find_missing_prs.sh +++ b/docs/docs/releases/find_missing_prs.sh @@ -39,10 +39,12 @@ fi RELEASE=$1 NOTES_FILE=$RELEASE.md +TEMPLATE_FILE=TEMPLATE.md # If the notes file doesn't yet exist, create one if [ ! -f $NOTES_FILE ]; then - echo "# Mathesar $RELEASE" > $NOTES_FILE + cp $TEMPLATE_FILE $NOTES_FILE + sed -i "s/__VERSION__/$RELEASE/g" $NOTES_FILE fi PREV_NOTES_FILE=$(ls -1 | sort | grep -B 1 $NOTES_FILE | head -n 1) @@ -122,4 +124,4 @@ echo $'\n\n## (TO CATEGORIZE)\n' >> $NOTES_FILE echo "$PR_LIST" >> $NOTES_FILE echo $'\n' >> $NOTES_FILE COUNT=$(wc -l <<< "$PR_LIST") -echo "$COUNT additional PRs written to $NOTES_FILE. Please categorize them." +echo "$COUNT PRs added to $NOTES_FILE. Please categorize them." From 5976217236d0ee6956834b3944750290c264d5fd Mon Sep 17 00:00:00 2001 From: Sean Colsen Date: Mon, 26 Feb 2024 20:19:27 -0500 Subject: [PATCH 08/21] Update version numbers to 0.1.5 --- mathesar/__init__.py | 2 +- pyproject.toml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/mathesar/__init__.py b/mathesar/__init__.py index 05ea0d9d02..c105751bbb 100644 --- a/mathesar/__init__.py +++ b/mathesar/__init__.py @@ -1,3 +1,3 @@ default_app_config = 'mathesar.apps.MathesarConfig' -__version__ = "0.1.4" +__version__ = "0.1.5" diff --git a/pyproject.toml b/pyproject.toml index f892604e96..e3096426a5 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [project] name = "Mathesar" -version = "0.1.4" +version = 0.1.5 [tool.vulture] exclude = ["mathesar/migrations"] ignore_names = ["go_to_patents_data_table", "go_to_all_types_table", "go_to_table_with_numbers_in_text", "admin_user"] From ad8180f29f379356c58b078ea00d1505fa57613a Mon Sep 17 00:00:00 2001 From: Sean Colsen Date: Tue, 27 Feb 2024 08:31:30 -0500 Subject: [PATCH 09/21] Fix quotes in version number --- pyproject.toml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pyproject.toml b/pyproject.toml index e3096426a5..8d22a36871 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [project] name = "Mathesar" -version = 0.1.5 +version = "0.1.5" [tool.vulture] exclude = ["mathesar/migrations"] ignore_names = ["go_to_patents_data_table", "go_to_all_types_table", "go_to_table_with_numbers_in_text", "admin_user"] From 8cf27d8be750eab5ca0b65d7cf51a64c3cae984b Mon Sep 17 00:00:00 2001 From: Sean Colsen Date: Tue, 27 Feb 2024 21:09:44 -0500 Subject: [PATCH 10/21] Add release notes PR to release notes --- docs/docs/releases/0.1.5.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/docs/releases/0.1.5.md b/docs/docs/releases/0.1.5.md index 5439826ed9..587ea712f2 100644 --- a/docs/docs/releases/0.1.5.md +++ b/docs/docs/releases/0.1.5.md @@ -17,6 +17,7 @@ TODO ## Documentation - Embedded video walkthrough within installation steps _[#3437](https://github.com/mathesar-foundation/mathesar/pull/3437 "Merge pull request #3436 from mathesar-foundation/video_walkthrough")_ _[#3443](https://github.com/mathesar-foundation/mathesar/pull/3443 "Merge pull request #3442 from mathesar-foundation/update_video_link")_ +- 0.1.5 release notes _[#3449](https://github.com/mathesar-foundation/mathesar/pull/3449 "0.1.5 release notes")_ ## Bug fixes From df8cf585de7666d3f5a98747079654d4de7c39d6 Mon Sep 17 00:00:00 2001 From: Sean Colsen Date: Tue, 27 Feb 2024 21:10:25 -0500 Subject: [PATCH 11/21] Fix unnecessary filter in release notes helper query --- docs/docs/releases/find_missing_prs.sh | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/docs/releases/find_missing_prs.sh b/docs/docs/releases/find_missing_prs.sh index 61fda834b6..0bf2bec6ff 100755 --- a/docs/docs/releases/find_missing_prs.sh +++ b/docs/docs/releases/find_missing_prs.sh @@ -83,7 +83,6 @@ git log --format=%H --first-parent $PREV_RELEASE..$RELEASE_BRANCH > $COMMITS_FIL # Find and cache details about all the PRs merged within the past year. This # gets more PRs than we need, but we'll filter it shortly. gh pr list \ - --base $RELEASE_BRANCH \ --limit 1000 \ --json additions,author,deletions,mergeCommit,title,url \ --search "is:closed merged:>$(date -d '1 year ago' '+%Y-%m-%d')" \ From ed928907d468d164ab2c8c2d301b1aeaa50656ba Mon Sep 17 00:00:00 2001 From: Sean Colsen Date: Tue, 27 Feb 2024 21:11:36 -0500 Subject: [PATCH 12/21] Add #3459 to release notes --- docs/docs/releases/0.1.5.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/docs/releases/0.1.5.md b/docs/docs/releases/0.1.5.md index 587ea712f2..16d3c94e8b 100644 --- a/docs/docs/releases/0.1.5.md +++ b/docs/docs/releases/0.1.5.md @@ -22,6 +22,7 @@ TODO ## Bug fixes - Fix "Page not found" error when viewing a shared exploration _[#3456](https://github.com/mathesar-foundation/mathesar/pull/3456 "Fix regression where `connections` list is empty in `common_data`")_ +- Fix bugs preventing Mathesar from running in demo mode _[#3459](https://github.com/mathesar-foundation/mathesar/pull/3459 "Fix Demo mode issues")_ - Restore display of column type icons within shared tables _[#3456](https://github.com/mathesar-foundation/mathesar/pull/3456 "Fix regression where `connections` list is empty in `common_data`")_ - Constrain the width of the connections page _[#3439](https://github.com/mathesar-foundation/mathesar/pull/3439 "Constrain the width of the connections page")_ - Temporarily hide link to missing docs page _[#3451](https://github.com/mathesar-foundation/mathesar/pull/3451 "Temporarily hide link to missing docs page")_ From 5ad0569766594832feb82aa0334805a3730cb6e3 Mon Sep 17 00:00:00 2001 From: Kriti Godey Date: Wed, 28 Feb 2024 10:46:52 -0500 Subject: [PATCH 13/21] Add back external Postgres server docs. --- docs/docs/configuration/env-variables.md | 3 +++ docs/docs/installation/docker-compose/index.md | 13 +++++++++++++ 2 files changed, 16 insertions(+) diff --git a/docs/docs/configuration/env-variables.md b/docs/docs/configuration/env-variables.md index 98208a2506..789c287a0f 100644 --- a/docs/docs/configuration/env-variables.md +++ b/docs/docs/configuration/env-variables.md @@ -50,6 +50,9 @@ 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. + ### `DOMAIN_NAME` - **Description**: The public URL that will be used to access Mathesar ([see Caddy docs](https://caddyserver.com/docs/caddyfile/concepts#addresses)). diff --git a/docs/docs/installation/docker-compose/index.md b/docs/docs/installation/docker-compose/index.md index efe5eeea54..8bc8d4f467 100644 --- a/docs/docs/installation/docker-compose/index.md +++ b/docs/docs/installation/docker-compose/index.md @@ -104,3 +104,16 @@ Add your domain(s) or sub-domain(s) to the [`DOMAIN_NAME`](../../configuration/e ``` Restart the docker containers for the configuration to take effect. + +### Using an external PostgreSQL server for Mathesar's internal database + +If you'd like to use an external PostgreSQL server for Mathesar's internal database, you'll need to do the following: + + +1. On the existing database server, [create a new database](https://www.postgresql.org/docs/current/sql-createdatabase.html) for Mathesar to store its metadata. + + ```bash + 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. From 176a57d0efe026be8ba2c91512dd9858ec14c275 Mon Sep 17 00:00:00 2001 From: Kriti Godey Date: Wed, 28 Feb 2024 10:48:45 -0500 Subject: [PATCH 14/21] Fixed broken link. --- docs/docs/installation/docker-compose/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docs/installation/docker-compose/index.md b/docs/docs/installation/docker-compose/index.md index 8bc8d4f467..bb9cab73fd 100644 --- a/docs/docs/installation/docker-compose/index.md +++ b/docs/docs/installation/docker-compose/index.md @@ -116,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/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. From f07b7d98d168aec8d2574527afc2d5744bc95e89 Mon Sep 17 00:00:00 2001 From: Kriti Godey Date: Wed, 28 Feb 2024 10:57:29 -0500 Subject: [PATCH 15/21] Added upgrade instructions --- docs/docs/releases/0.1.5.md | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/docs/docs/releases/0.1.5.md b/docs/docs/releases/0.1.5.md index 16d3c94e8b..19f7f8f305 100644 --- a/docs/docs/releases/0.1.5.md +++ b/docs/docs/releases/0.1.5.md @@ -8,7 +8,20 @@ _This page provides a comprehensive list of all changes in the release._ ## Upgrading to Mathesar 0.1.5 -TODO +### For installations using Docker Compose + +If you have a Docker compose installation (including one from the guided script), run the command below: + +⚠️ You may need to change `/etc/mathesar/` in the command above if you chose to install Mathesar to a different directory. + +``` +docker compose -f /etc/mathesar/docker-compose.yml up \ + --force-recreate --build service +``` + +### For installations done from scratch + +If you installed from scratch, the upgrade instructions are the same as [for 0.1.4](../../administration/upgrade/0.1.4/#scratch), but you can skip Step 5 – you do not need to change the environment variables. ## Features From 9518640c1bf18ccedfd6097d2679834c97a17080 Mon Sep 17 00:00:00 2001 From: Brent Moran Date: Wed, 28 Feb 2024 10:27:05 -0600 Subject: [PATCH 16/21] Fix version number --- docs/docs/releases/0.1.5.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docs/releases/0.1.5.md b/docs/docs/releases/0.1.5.md index 19f7f8f305..ce1c63852d 100644 --- a/docs/docs/releases/0.1.5.md +++ b/docs/docs/releases/0.1.5.md @@ -2,7 +2,7 @@ ## Summary -Mathesar 0.1.4 is a small, bug fix release. +Mathesar 0.1.5 is a small, bug fix release. _This page provides a comprehensive list of all changes in the release._ From da00abbd79f18f724e07ad4ff4e2acca971d5d76 Mon Sep 17 00:00:00 2001 From: Brent Moran Date: Wed, 28 Feb 2024 10:31:34 -0600 Subject: [PATCH 17/21] Remove misdirected 'above' --- docs/docs/releases/0.1.5.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docs/releases/0.1.5.md b/docs/docs/releases/0.1.5.md index ce1c63852d..9e0df4aad5 100644 --- a/docs/docs/releases/0.1.5.md +++ b/docs/docs/releases/0.1.5.md @@ -12,7 +12,7 @@ _This page provides a comprehensive list of all changes in the release._ If you have a Docker compose installation (including one from the guided script), run the command below: -⚠️ You may need to change `/etc/mathesar/` in the command above if you chose to install Mathesar to a different directory. +⚠️ You may need to change `/etc/mathesar/` in this command if you chose to install Mathesar to a different directory. ``` docker compose -f /etc/mathesar/docker-compose.yml up \ From 75a2b090d1e6314851691bd282fdd2c7dbf3dd45 Mon Sep 17 00:00:00 2001 From: Sean Colsen Date: Wed, 28 Feb 2024 11:38:14 -0500 Subject: [PATCH 18/21] Add release notes to nav --- docs/mkdocs.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index 1212ea5fa6..49ee88cece 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -24,6 +24,7 @@ nav: - Users & access levels: user-guide/users.md - Glossary: user-guide/glossary.md - Releases: + - '0.1.5': releases/0.1.5.md - '0.1.4': releases/0.1.4.md - '0.1.3': releases/0.1.3.md - '0.1.2': releases/0.1.2.md From 49a0d07911473d7dae1744ff4655a3359b0fbd3b Mon Sep 17 00:00:00 2001 From: Sean Colsen Date: Wed, 28 Feb 2024 12:06:30 -0500 Subject: [PATCH 19/21] Add #3457 to release notes --- docs/docs/releases/0.1.5.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/docs/releases/0.1.5.md b/docs/docs/releases/0.1.5.md index 9e0df4aad5..0812ab740b 100644 --- a/docs/docs/releases/0.1.5.md +++ b/docs/docs/releases/0.1.5.md @@ -29,6 +29,7 @@ If you installed from scratch, the upgrade instructions are the same as [for 0.1 ## Documentation +- Improve docs on using an external PostgreSQL server for Mathesar's internal database _[#3457](https://github.com/mathesar-foundation/mathesar/pull/3457 "Updates to documentation")_ - Embedded video walkthrough within installation steps _[#3437](https://github.com/mathesar-foundation/mathesar/pull/3437 "Merge pull request #3436 from mathesar-foundation/video_walkthrough")_ _[#3443](https://github.com/mathesar-foundation/mathesar/pull/3443 "Merge pull request #3442 from mathesar-foundation/update_video_link")_ - 0.1.5 release notes _[#3449](https://github.com/mathesar-foundation/mathesar/pull/3449 "0.1.5 release notes")_ From 5e50daf7cd7d465bf941dd00485ffc7bbe5cd0a3 Mon Sep 17 00:00:00 2001 From: Kriti Godey Date: Wed, 28 Feb 2024 13:35:55 -0500 Subject: [PATCH 20/21] Release notes improvements --- docs/docs/administration/upgrade/0.1.5.md | 18 +++++++++++++ docs/docs/releases/0.1.5.md | 32 +++++++---------------- docs/mkdocs.yml | 1 + 3 files changed, 29 insertions(+), 22 deletions(-) create mode 100644 docs/docs/administration/upgrade/0.1.5.md diff --git a/docs/docs/administration/upgrade/0.1.5.md b/docs/docs/administration/upgrade/0.1.5.md new file mode 100644 index 0000000000..855de0bf3c --- /dev/null +++ b/docs/docs/administration/upgrade/0.1.5.md @@ -0,0 +1,18 @@ +# Upgrade Mathesar to 0.1.5 + +### For installations using Docker Compose + +If you have a Docker compose installation (including one from the guided script), run the command below: + +``` +docker compose -f /etc/mathesar/docker-compose.yml up \ + --force-recreate --build service +``` + +!!! warning "Your installation directory may be different" + You may need to change `/etc/mathesar/` in the command above if you chose to install Mathesar to a different directory. + + +### For installations done from scratch + +If you installed from scratch, the upgrade instructions are the same as [for 0.1.4](../../administration/upgrade/0.1.4/#scratch), but you can skip Step 5 – you do not need to change the environment variables. diff --git a/docs/docs/releases/0.1.5.md b/docs/docs/releases/0.1.5.md index 0812ab740b..751a4d4e30 100644 --- a/docs/docs/releases/0.1.5.md +++ b/docs/docs/releases/0.1.5.md @@ -8,40 +8,28 @@ _This page provides a comprehensive list of all changes in the release._ ## Upgrading to Mathesar 0.1.5 -### For installations using Docker Compose +See our guide on [upgrading Mathesar to 0.1.5](../administration/upgrade/0.1.5.md). -If you have a Docker compose installation (including one from the guided script), run the command below: - -⚠️ You may need to change `/etc/mathesar/` in this command if you chose to install Mathesar to a different directory. - -``` -docker compose -f /etc/mathesar/docker-compose.yml up \ - --force-recreate --build service -``` - -### For installations done from scratch - -If you installed from scratch, the upgrade instructions are the same as [for 0.1.4](../../administration/upgrade/0.1.4/#scratch), but you can skip Step 5 – you do not need to change the environment variables. - -## Features +## Improvements - Improve performance of loading sample data when adding a new connection _[#3448](https://github.com/mathesar-foundation/mathesar/pull/3448 "Efficient data loader")_ - -## Documentation - -- Improve docs on using an external PostgreSQL server for Mathesar's internal database _[#3457](https://github.com/mathesar-foundation/mathesar/pull/3457 "Updates to documentation")_ -- Embedded video walkthrough within installation steps _[#3437](https://github.com/mathesar-foundation/mathesar/pull/3437 "Merge pull request #3436 from mathesar-foundation/video_walkthrough")_ _[#3443](https://github.com/mathesar-foundation/mathesar/pull/3443 "Merge pull request #3442 from mathesar-foundation/update_video_link")_ -- 0.1.5 release notes _[#3449](https://github.com/mathesar-foundation/mathesar/pull/3449 "0.1.5 release notes")_ +- Constrain the width of the connections page _[#3439](https://github.com/mathesar-foundation/mathesar/pull/3439 "Constrain the width of the connections page")_ ## Bug fixes - Fix "Page not found" error when viewing a shared exploration _[#3456](https://github.com/mathesar-foundation/mathesar/pull/3456 "Fix regression where `connections` list is empty in `common_data`")_ - Fix bugs preventing Mathesar from running in demo mode _[#3459](https://github.com/mathesar-foundation/mathesar/pull/3459 "Fix Demo mode issues")_ +- Fix timeout when setting up a new database with sample data in installations with higher network latency _[#3448](https://github.com/mathesar-foundation/mathesar/pull/3448 "Efficient data loader")_ - Restore display of column type icons within shared tables _[#3456](https://github.com/mathesar-foundation/mathesar/pull/3456 "Fix regression where `connections` list is empty in `common_data`")_ -- Constrain the width of the connections page _[#3439](https://github.com/mathesar-foundation/mathesar/pull/3439 "Constrain the width of the connections page")_ - Temporarily hide link to missing docs page _[#3451](https://github.com/mathesar-foundation/mathesar/pull/3451 "Temporarily hide link to missing docs page")_ - Fix active cell displaying above row header cell _[#3382](https://github.com/mathesar-foundation/mathesar/pull/3382 "Fix active cell displaying above row header cell")_ +## Documentation + +- Improve docs on using an external PostgreSQL server for Mathesar's internal database _[#3457](https://github.com/mathesar-foundation/mathesar/pull/3457 "Updates to documentation")_ +- Add embedded video walkthrough within installation steps _[#3437](https://github.com/mathesar-foundation/mathesar/pull/3437 "Merge pull request #3436 from mathesar-foundation/video_walkthrough")_ _[#3443](https://github.com/mathesar-foundation/mathesar/pull/3443 "Merge pull request #3442 from mathesar-foundation/update_video_link")_ +- 0.1.5 release notes _[#3449](https://github.com/mathesar-foundation/mathesar/pull/3449 "0.1.5 release notes")_ + ## Maintenance - Improve our release notes helper script _[#3435](https://github.com/mathesar-foundation/mathesar/pull/3435 "Merge pull request #3434 from mathesar-foundation/release_notes")_ diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index 49ee88cece..7124cc34c6 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -14,6 +14,7 @@ nav: - Connect to an existing database server: configuration/connect-to-existing-db.md - Administration: - Upgrade: + - To 0.1.5: administration/upgrade/0.1.5.md - To 0.1.4: administration/upgrade/0.1.4.md - To older versions: administration/upgrade/older.md - Uninstall Mathesar: administration/uninstall.md From 75aacbacf07171abeb799091f6ab4e73d127d366 Mon Sep 17 00:00:00 2001 From: Sean Colsen Date: Wed, 28 Feb 2024 15:00:58 -0500 Subject: [PATCH 21/21] Propagate release notes structure changes to template --- docs/docs/releases/TEMPLATE.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/docs/releases/TEMPLATE.md b/docs/docs/releases/TEMPLATE.md index 19fe774434..5b1ab24200 100644 --- a/docs/docs/releases/TEMPLATE.md +++ b/docs/docs/releases/TEMPLATE.md @@ -17,7 +17,7 @@ TODO - + @@ -25,10 +25,10 @@ TODO - + - +