Skip to content

Commit

Permalink
Merge pull request #3949 from mathesar-foundation/release-notes
Browse files Browse the repository at this point in the history
Release notes for 0.2.0-testing.1
  • Loading branch information
mathemancer authored Oct 15, 2024
2 parents f82a237 + 75d5569 commit 0fdd816
Show file tree
Hide file tree
Showing 9 changed files with 252 additions and 5 deletions.
2 changes: 1 addition & 1 deletion docker-compose.yml
Original file line number Diff line number Diff line change
Expand Up @@ -144,7 +144,7 @@ services:
#
service:
container_name: mathesar_service
image: mathesar/mathesar-prod:latest
image: mathesar/mathesar-testing:latest
environment:
# First we load the variables configured above.
<<: *config
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/api/rpc.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Mathesar has an API available at `/api/rpc/v0/` which follows the [JSON-RPC](https://www.jsonrpc.org/specification) spec version 2.0.

!!! caution "Not yet stable"
!!! danger "Not yet stable"
The RPC API is not yet stable and may change in the future. If you build logic that depends on this API, be mindful that it may change in the future without warning or notice.

## Usage
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
7 changes: 6 additions & 1 deletion docs/docs/index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
# Mathesar Documentation

!!! question "Help us get our beta out sooner – send us feedback!"
You're looking at the documentation for our **✨ new test build ✨**, see [release notes here](releases/0.2.0-testing.1.md).

For a timely and stable beta release, we need feedback from as many users as possible about how this new version of Mathesar is working for you. Let us know on [this GitHub discussion](https://github.com/mathesar-foundation/mathesar/discussions/3956) or drop us a line at <[email protected]>.

## Welcome!

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 &mdash; 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).
Expand All @@ -17,7 +22,7 @@ This is a quick way to play with Mathesar locally, but is not appropriate for sa
1. With [Docker](https://docs.docker.com/get-docker/) installed, run:

```
docker run -it --name mathesar -p 8000:8000 mathesar/mathesar-prod:latest
docker run -it --name mathesar -p 8000:8000 mathesar/mathesar-testing:latest
```
1. Visit [http://localhost:8000/](http://localhost:8000/) to set up an admin user account and create a database connection.
Expand Down
7 changes: 5 additions & 2 deletions docs/docs/installation/build-from-source/index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
# 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.

!!! 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 @@ -131,14 +134,14 @@ Then press <kbd>Enter</kbd> to customize this guide with your domain name.
git clone https://github.com/mathesar-foundation/mathesar.git .
```
1. Checkout the tag of the latest stable release, `{{mathesar_version}}`.
1. Check out the tag of the release or build you'd like to install, `{{mathesar_version}}`.
```
git checkout {{mathesar_version}}
```
!!! warning "Important"
If you don't run the above command you'll end up installing the latest _development_ version of Mathesar, which will be less stable.
If you don't run the above command you'll end up installing the latest _development_ version of Mathesar.
1. We need to create a python virtual environment for the Mathesar application.
Expand Down
3 changes: 3 additions & 0 deletions docs/docs/installation/docker-compose/index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
# 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
234 changes: 234 additions & 0 deletions docs/docs/releases/0.2.0-testing.1.md

Large diffs are not rendered by default.

2 changes: 2 additions & 0 deletions docs/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,8 @@ nav:
- API:
- RPC: api/rpc.md
- REST: api/rest.md
- Test Builds:
- '0.2.0-testing.1': releases/0.2.0-testing.1.md
- Releases:
- '0.1.7': releases/0.1.7.md
- '0.1.6': releases/0.1.6.md
Expand Down

0 comments on commit 0fdd816

Please sign in to comment.