-
-
Notifications
You must be signed in to change notification settings - Fork 16
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
fix: updated the folksonomy install-md file #233
base: main
Are you sure you want to change the base?
Conversation
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 @parthshah02! This is almost done, but not completely. Could you have a look at my comments?
|
||
```pip install -r requirements.txt``` | ||
|
||
# Step 6: Set Up PostgreSQL Database |
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.
Here I think you must explain the two options:
- either using a local postgre
- either using
./start_postgres.sh
, which launch a ready to use postgre container
The documentation should clearly explain both cases.
@@ -69,15 +95,12 @@ cp local_settings_example.py local_settings.py | |||
python ./db-migration.py |
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.
Redundant with step 6 where you already use yoyo apply --database postgresql:///folksonomy
?
I would put python ./db-migration.py
in a 8th step.
The documentation should make the difference between the things you have to do one time, and the things you have to do every time you want to get back to your dev environment.
Either you can mention in comment the steps which need to be setup only one time. Either you can add a second part at the end of the doc:
# Relaunch dev environment after install
If you have closed your computer and you want to relaunch dev environement, you have to redo some of the previous steps, but not all ones.
[...]
Co-authored-by: Charles Nepote <[email protected]>
Co-authored-by: Charles Nepote <[email protected]>
Using numbered steps is a good idea, and you're almost done. The goal of this document:
|
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #233 +/- ##
==========================================
- Coverage 95.06% 94.49% -0.58%
==========================================
Files 5 5
Lines 324 363 +39
==========================================
+ Hits 308 343 +35
- Misses 16 20 +4 ☔ View full report in Codecov by Sentry. |
What