Skip to content

Commit 445696d

Browse files
kvchandrew-farries
andauthored
Rewrite the front page of the docs (#809)
This is another step towards having a clearer documentation. I restructured the front page and added "sign posts" so users can understand our documentation flow a bit better. --------- Co-authored-by: Andrew Farries <[email protected]>
1 parent 9249605 commit 445696d

File tree

2 files changed

+29
-3
lines changed

2 files changed

+29
-3
lines changed

docs/getting-started.md

Lines changed: 28 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,32 @@
1-
# Getting started
1+
# Welcome to pgroll's documentation
22

3-
This guide covers the key concepts of `pgroll` and how to get started with it.
3+
`pgroll` is a migration tool for PostgreSQL that makes it easy to apply schema changes safely, without application downtime. It supports instant rollbacks and helps ensure applications stay available during database schema changes by allowing applications to access different versions of your database schema.
4+
5+
## Getting started
6+
7+
Learn how `pgroll` simplifies zero-downtime migrations for you
8+
9+
* [Why use pgroll](why-use-pgroll)
10+
* [Installation](installation)
11+
* [Concepts](concepts)
12+
* [Write your first migration](tutorial)
13+
14+
## Guides
15+
16+
Learn how to use `pgroll` in your developer workflow
17+
18+
* [Integrate pgroll into your project](guides/clientapps)
19+
* [Use pgroll with ORMs](guides/orms)
20+
* [Writing up and down migrations](guides/updown)
21+
22+
## Connect with us
23+
24+
If you have questions reach out to us on our
25+
* [Discord server](https://xata.io/discord)
26+
* [Github Discussion board](https://github.com/xataio/pgroll/discussions)
27+
28+
If you want to report issues or submit feedback visit
29+
* [Github Issues](https://github.com/xataio/pgroll/issues)
430

531
## Supported Postgres versions
632

docs/guides/clientapps.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Integrate pgroll into your project
22

3-
`pgroll` maintains multiple versions of the database schema side-by-side. For more details see the [getting started page](docs/getting-started.md).
3+
`pgroll` maintains multiple versions of the database schema side-by-side. For more details see the [Concepts page](concepts).
44

55
## Client applications
66

0 commit comments

Comments
 (0)