Skip to content

Commit 481e5a7

Browse files
authored
Extract Installation to the left menu (#796)
This PR extracts the section "Installation" from the "Getting started" page. This is an important step for new users, and Installation was hidden at the bottom of "Getting started". From now on, Installation is more prominent and easier to find.
1 parent 07ba13c commit 481e5a7

File tree

3 files changed

+31
-26
lines changed

3 files changed

+31
-26
lines changed

docs/config.json

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,11 @@
55
"href": "/getting-started",
66
"file": "docs/getting-started.md"
77
},
8+
{
9+
"title": "Installation",
10+
"href": "/installation",
11+
"file": "docs/install-pgroll.md"
12+
},
813
{
914
"title": "Tutorial",
1015
"href": "/tutorial",

docs/getting-started.md

Lines changed: 0 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -56,32 +56,6 @@ In practice, the `searchPath` variable would be provided to the application as a
5656

5757
If an application doesn't set the `search_path` for the connection, the `search_path` defaults to the `public` schema, meaning that the application will be working with the underlying tables directly rather than accessing them through the versioned views.
5858

59-
## Installation
60-
61-
### Binaries
62-
63-
Binaries are available for Linux, macOS & Windows on our [Releases](https://github.com/xataio/pgroll/releases) page.
64-
65-
### From source
66-
67-
To install `pgroll` from source, run the following command:
68-
69-
```sh
70-
go install github.com/xataio/pgroll@latest
71-
```
72-
73-
Note: requires [Go 1.24](https://golang.org/doc/install) or later.
74-
75-
### From package manager - Homebrew
76-
77-
To install `pgroll` with homebrew, run the following command:
78-
79-
```sh
80-
# macOS or Linux
81-
brew tap xataio/pgroll
82-
brew install pgroll
83-
```
84-
8559
## Supported Postgres versions
8660

8761
`pgroll` supports Postgres versions >= 14.

docs/install-pgroll.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# Installation
2+
3+
## Binaries
4+
5+
Binaries are available for Linux, macOS & Windows on our [Releases](https://github.com/xataio/pgroll/releases) page.
6+
7+
## From source
8+
9+
To install `pgroll` from source, run the following command:
10+
11+
```sh
12+
go install github.com/xataio/pgroll@latest
13+
```
14+
15+
Note: requires [Go 1.24](https://golang.org/doc/install) or later.
16+
17+
## From package manager - Homebrew
18+
19+
To install `pgroll` with homebrew, run the following command:
20+
21+
```sh
22+
# macOS or Linux
23+
brew tap xataio/pgroll
24+
brew install pgroll
25+
```
26+

0 commit comments

Comments
 (0)