chore: remove redundant init_db.sh script and documentation references#64
Open
Farhan-Abbas wants to merge 2 commits into
Open
chore: remove redundant init_db.sh script and documentation references#64Farhan-Abbas wants to merge 2 commits into
Farhan-Abbas wants to merge 2 commits into
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Removes the unused init_db.sh database initialization script and updates quick-start documentation to avoid instructing users to manually create a database that Docker/Postgres already provisions on first initialization (Fixes Issue #60).
Changes:
- Removed
workbench/init_db.sh. - Updated setup instructions in
workbench/README.md, rootREADME.md, anddocs/getting-started.mdto drop the redundant DB init step and renumber steps accordingly. - Removed the obsolete initialization reference from
CLAUDE.md.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| workbench/README.md | Updates “First Time Setup” to remove init_db.sh and focus on migrations/superuser creation. |
| workbench/init_db.sh | Deletes the redundant DB creation script. |
| README.md | Removes the DB init step from the top-level quick start and renumbers remaining steps. |
| docs/getting-started.md | Mirrors the quick-start update by removing the DB init step and renumbering. |
| CLAUDE.md | Removes the first-time init_db.sh instruction. |
Comments suppressed due to low confidence (1)
README.md:90
- Since
init_db.shwas removed, the docs no longer mention what to do if the PostgreSQL volume already exists but thestarfish-routerDB is missing (common after manual DB cleanup or reusing old volumes). Consider adding a brief troubleshooting note near this step explaining that DB creation only happens on first init, and users can either recreate the DB inside Postgres or remove thepostgres_datavolume and rerunmake up.
3. **Run migrations and create superuser** (first time only)
```bash
docker exec -it starfish-router poetry run python3 manage.py makemigrations
docker exec -it starfish-router poetry run python3 manage.py migrate
docker exec -it starfish-router poetry run python3 manage.py createsuperuser
</details>
---
💡 <a href="/denoslab/starfish-fl/new/main?filename=.github/instructions/*.instructions.md" class="Link--inTextBlock" target="_blank" rel="noopener noreferrer">Add Copilot custom instructions</a> for smarter, more guided reviews. <a href="https://docs.github.com/en/copilot/customizing-copilot/adding-repository-custom-instructions-for-github-copilot" class="Link--inTextBlock" target="_blank" rel="noopener noreferrer">Learn how to get started</a>.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes Issue #60