Add installation guides #16
Conversation
There was a problem hiding this comment.
Pull request overview
This pull request adds comprehensive installation guides for PostgreSQL database across multiple operating systems (macOS, Windows, and Linux Ubuntu). The changes improve the documentation by providing platform-specific instructions using tabbed interfaces, making it easier for users on different systems to follow the appropriate setup steps.
Key Changes
- Added Windows and Linux (Ubuntu) installation guides to the PostgreSQL database documentation
- Introduced platform-specific tabs for database creation commands in the installation guide
- Updated SQL commands to use uppercase convention (CREATE DATABASE instead of create database)
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 10 comments.
| File | Description |
|---|---|
content/docs/documentation/installing-postgresql-database.mdx |
Added Windows and Linux Ubuntu installation sections with step-by-step guides for PostgreSQL 15, including installer instructions, verification steps, and database creation commands |
content/docs/documentation/get-started/installation.mdx |
Added platform-specific tabs for database creation commands, updated prerequisite links, added npm run prisma:generate command, and modified curl command for Windows compatibility |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| curl -X 'GET' \ | ||
| 'http://localhost:3001/api/v1/health/' \ | ||
| -H 'accept: application/json' | ||
| curl.exe -X GET "http://localhost:3001/api/v1/health/" -H "accept: application/json" |
There was a problem hiding this comment.
The curl command has been changed to curl.exe, which is Windows-specific. This section is within the "Manual Setup" tab which is not platform-specific. Consider using platform-specific tabs for this command, or providing both Unix and Windows versions, similar to how the PostgreSQL setup commands are handled (lines 119-150).
There was a problem hiding this comment.
This is windows specific, but we are using unix by default. Add tabs if you want to have windows commands here.
|
Can this be one code block? 
|
enjojoy
left a comment
enjojoy
left a comment
There was a problem hiding this comment.
LGTM, but a couple things are not clear to me, please explain or fix
| Run the following commands to configure the database schema: | ||
|
|
||
| ```bash | ||
| npm run prisma:generate |
There was a problem hiding this comment.
Why do we need to generate? It worked before without it?
| ```bash | ||
| npm run build && npm start | ||
| npm run build | ||
| npm start |
There was a problem hiding this comment.
This is because windows can't work with && but all of them can work with several lines
| curl -X 'GET' \ | ||
| 'http://localhost:3001/api/v1/health/' \ | ||
| -H 'accept: application/json' | ||
| curl.exe -X GET "http://localhost:3001/api/v1/health/" -H "accept: application/json" |
There was a problem hiding this comment.
This is windows specific, but we are using unix by default. Add tabs if you want to have windows commands here.
pia-roettcher
force-pushed
the
add_installation_guids
branch
2 times, most recently
from
82d4a46 to
092164b
Compare
pia-roettcher
force-pushed
the
add_installation_guids
branch
from
092164b to
1c206cd
Compare
2 participants
Main guide and postgres guide for Windows and Linux Ubuntu