Clean up README #13
Merged
Clean up README #13
Conversation
This file contains 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
mxcl
requested review from
sanchitram1,
jhheider and
toby
and removed request for
sanchitram1
toby
reviewed
Oct 21, 2024
README.md
Outdated
|
|
||
| 1. `rm -rf ./data`: removes all the data the fetcher is putting. | ||
| 2. `docker system prune -a -f --volumes`: removes **everything** | ||
| docker-related † |
There was a problem hiding this comment.
I vote to remove this. It's dangerous and beyond the scope of our project. rm -rf data and docker compose down are sufficient.
There was a problem hiding this comment.
or a command to remove our specific volumes. but aren't we no longer using volumes, just mounts?
There was a problem hiding this comment.
in Homebrew, I mounted volumes for testing purposes, but that's actually not needed.
toby
approved these changes
Oct 21, 2024
jhheider
reviewed
Oct 21, 2024
|
|
||
| 1. `db`: [PostgreSQL] database for the reduced package data | ||
| 2. `alembic`: handles migrations | ||
| 3. `pipeline`: fetches and writes data |
There was a problem hiding this comment.
should add
4. `api`: a simple REST api for reading from the db
README.md
Outdated
|
|
||
| 1. `rm -rf ./data`: removes all the data the fetcher is putting. | ||
| 2. `docker system prune -a -f --volumes`: removes **everything** | ||
| docker-related † |
There was a problem hiding this comment.
or a command to remove our specific volumes. but aren't we no longer using volumes, just mounts?
Comment on lines
+244
to
+251
| [PostgreSQL]: https://www.postgresql.org | ||
| [`pkgx`]: https://pkgx.sh |
sanchitram1
force-pushed
the
readme-cleanup
branch
from
2725c67 to
990456b
Compare
sanchitram1
approved these changes
Oct 21, 2024
Merged
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.
Some diff lines are just forcing an 80 character wrap.
Ensure you squash.
Aside: this repo should be renamed
chaibefore publication.