Skip to content
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

Merged
merged 2 commits into from
Mar 9, 2019

Conversation

anthonyblond
Copy link
Contributor

As per #8

@jonasbn
Copy link
Contributor

jonasbn commented Feb 4, 2019

Oh could I review the proposed addition?

@codecov-io
Copy link

codecov-io commented Feb 4, 2019

Codecov Report

Merging #10 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           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.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update a7b36a4...9d87423. Read the comment docs.

@ufoscout
Copy link
Owner

ufoscout commented Feb 4, 2019

@unfinishedteleporter
Thank you for this PR. It looks good to me.

@jonasbn
sure! your feedback will be appreciated. Let me know.

README.md Outdated Show resolved Hide resolved
Copy link
Contributor

@jonasbn jonasbn left a 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.

README.md Outdated Show resolved Hide resolved
Copy link
Contributor

@jonasbn jonasbn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good

@ufoscout ufoscout merged commit 06d33cf into ufoscout:master Mar 9, 2019
@ufoscout
Copy link
Owner

ufoscout commented Mar 9, 2019

@unfinishedteleporter @jonasbn
thank you, guys!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants