-
Notifications
You must be signed in to change notification settings - Fork 145
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
Add readme explanation re usage in docker-compose #10
Add readme explanation re usage in docker-compose #10
Conversation
Oh could I review the proposed addition? |
Codecov Report
@@ Coverage Diff @@
## master #10 +/- ##
=======================================
Coverage 94.15% 94.15%
=======================================
Files 5 5
Lines 171 171
=======================================
Hits 161 161
Misses 10 10 Continue to review full report at Codecov.
|
@unfinishedteleporter @jonasbn |
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.
Do note, that this is only a suggestion. I am just of the opinion that the structure of documentation is important and often people do not want to ready AWOT or similar to get an issue out of the way. So it should be easy to identify/recognise, easy to apply and with information to get the full understanding. This does have the challenge of people reading the first part, applying the remed/solution without understanding the why.
The 3 bullets I listed in the review could also be read as:
- What
- How
- Why
I will stop now and get back to work - looking forward to your comments.
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.
Looks good
@unfinishedteleporter @jonasbn |
As per #8