hasura / ddn-docs

Repository for the Hasura DDN version of docs
https://hasura.io/docs
2 stars 6 forks source link

add guide to run postgres locally #560

Closed rikinsk closed 2 months ago

rikinsk commented 2 months ago

Description

Review thoughts:

Quick Links 🚀

https://rikinsk-add-adminer.v3-docs-eny.pages.dev/connectors/postgresql/local-postgres

🤖 DX: Assertion Tests

robertjdominguez commented 2 months ago

DX: Assertion Testing

✅ Diff

The PR provides a comprehensive guide for setting up a local Postgres database using Docker which is useful for new users. The instructions are clear, and the addition of Adminer offers a simple way to manage the database. Highlighting commands and the ports section improves usability by drawing attention to key information.

✅ Integrated

The PR's integration with the entire set of changed files supports overall usability by providing an easily accessible guide for setting up a local database, which is referenced from relevant places within the documentation. Connecting this new guide with the '_01-connect-a-source.mdx' file and updating the quickstart to mention the local setup option enhances the flow and makes it easy for users to find tools to start a local database when needed.

robertjdominguez commented 2 months ago

Images automagically compressed by Calibre's image-actions

Compression reduced images by 15.5%, saving 7.79 KB.

Filename Before After Improvement Visual comparison
static/img/databases/local-postgres/adminer.png 50.34 KB 42.55 KB -15.5% View diff

156 images did not require optimisation.

cloudflare-workers-and-pages[bot] commented 2 months ago

Deploying v3-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: 05e9b7f
Status: ✅  Deploy successful!
Preview URL: https://d5bd85ec.v3-docs-eny.pages.dev
Branch Preview URL: https://rikinsk-add-adminer.v3-docs-eny.pages.dev

View logs

robertjdominguez commented 2 months ago

Redirects 🔀

Hey, @robertjdominguez & @seanparkross — the following redirects will be needed for deployment:

# TEST ME: https://stage.hasura.io/docs/3.0/getting-started/build/03-connect-to-data/_databaseDocs/_postgreSQL/_01-connect-a-source/
location = /docs/3.0/getting-started/build/03-connect-to-data/_databaseDocs/_postgreSQL/_01-connect-a-source/ {
    return 301 https://$host/docs/3.0/OG-FILE-WAS-DELETED-REPLACE-ME-WITH-NEW-LOCATION;
}
rikinsk commented 2 months ago

addressed review comments