-
Notifications
You must be signed in to change notification settings - Fork 7k
Enhance initial-setup README with additional Docker & PGAdmin instructions #305
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Enhance initial-setup README with additional Docker & PGAdmin instructions #305
Conversation
We already have these steps written in more explained way in readme. |
@isangwanrahul Hey thanks for reviewing. Could you point to where please as I'm not seeing it. This PR complements the existing steps and unblocked at least several people in just one day, enabling them to complete setup, and will hopefully reduce future support requests. |
I meant to say I don't see any significant change in the commit. It's just reordering and reformatting. Thanks. |
I can see how it appears that way. However, starting the Postgres install section by directing to option 2 over 1 helps people use containers and are less likely to have custom issues. And whilst changed lines 84-90 are just reformatted, lines 92 onwards provide crucial additional detail for those struggling. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The enhancements to the README for initial setup, including Docker and PGAdmin instructions, provide substantial clarity and guidance for community users. The detailed steps and insights provided are highly valuable.
Recommendation: Approve for Merge
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Revoke previous approval due to changes needed.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Code Quality
The code quality in this pull request is strong, focusing on enhancing the documentation with clear, concise steps for utilizing Docker and PGAdmin. The use of markdown for formatting and instructive comments makes the steps easy to follow.
Changes
- Enhanced README with detailed instructions for setting up Postgres and PGAdmin using Docker.
- Added visual aids (image) and step-by-step descriptions to avoid user confusion.
- Segregated Docker setup instructions emphasizing best practices.
Creator Fairness
The changes made by the author are well-considered and add significant value to the documentation, focusing on user experience enhancement. The contributions are clear, fair, and complement the existing documentation without redundancy.
Merge Recommendation
This pull request should be merged as it provides well-drafted, detailed documentation improvements that will aid developers in setting up their environment consistently and correctly.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for the review, Zach!
I've rebased my branch to bring in the latest change where there was a significant refactor and the readme became much clearer (good work, Rahul). I reviewed both versions and determined re-ordering how to install PostgreSQL, plus reincorporating some of my original doc tweaks will ensure new developers have a painless experience.
…GAdmin steps Rebased branch onto current `main` ; some earlier overlapping edits were already incorporated upstream. This commit: - Moves Docker setup to Option A so new developers see the simplest path first. - Adds a brief note explaining what the `.env` file stores. - Expands PGAdmin instructions with step-by-step UI guidance.
e97bb00
to
83fe9bf
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The PR has been updated and is ready for review again:
-
Rebased this branch onto current
main
; the refactor since made the readme much clearer (good work, Rahul), so some parts of this PR are no longer needed. -
Remaining changes for review:
-
Step 2 re-ordering – put the simplest & preferred (Docker) option first so new developers see it immediately—Documentation should cater to the target audience, and in the case of new developers they are likely to work through the docs and carry out the first options which come up. I ensured there are no invalidated cross-references elsewhere.
-
Doc tweaks – reincorporated remaining original tip additions in new, logical locations.
-
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for the review, Zach!
I've rebased my branch to bring in the latest change where there was a significant refactor and the readme became much clearer (good work, Rahul). I reviewed both versions and determined re-ordering how to install PostgreSQL, plus reincorporating some of my original doc tweaks will ensure new developers have a painless experience.
Add additional steps complementing the existing Dimensional Data Modeling guide for setting up Postgres in Docker, including locating credentials to log in to PGAdmin, noting browser quirks, and walking through how to add a new server.
These steps were written for the community, and following positive feedback, I felt they should be included in the documentation.