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

Improve readme instructions issue#35 #64

Merged
merged 28 commits into from
Mar 27, 2018

Conversation

nelsonic
Copy link
Member

@nelsonic nelsonic commented Mar 7, 2018

@nelsonic nelsonic self-assigned this Mar 7, 2018
@codecov
Copy link

codecov bot commented Mar 7, 2018

Codecov Report

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

Impacted file tree graph

@@           Coverage Diff           @@
##           master      #64   +/-   ##
=======================================
  Coverage   99.59%   99.59%           
=======================================
  Files          21       21           
  Lines         247      247           
=======================================
  Hits          246      246           
  Misses          1        1

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 9aec5c4...1046356. Read the comment docs.

@SimonLab
Copy link
Member

SimonLab commented Mar 8, 2018

We might need to update the Erlang version on Travis:
image

We can define the version in our travis.yml file, see https://docs.travis-ci.com/user/languages/erlang/

However I don't think the error is directly linked to the Erlang version, I'll try to see what cause the exit status to 1:
image

@nelsonic
Copy link
Member Author

@Cleop / @iteles / @SimonLab
I made some pretty substantial updates to the readme
including an end-to-end set of screenshots and installation instructions.
Not going to add anything else now, so feel free to review and give feedback.
For reading the README.md changes, see:
https://github.com/dwyl/github-backup/blob/improve-readme-instructions-issue%2335/README.md

Thanks! ❤️

Copy link
Member

@Cleop Cleop left a comment

Choose a reason for hiding this comment

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

A couple of small typos but otherwise it's looking 💯 🏅 , so much detail, nice one @nelsonic

.env_sample Outdated
export SECRET_KEY_BASE=run:mix_phx.gen.secret-in-terminal-and-paste-result-here

# AWS:
export AWS_ACCESS_KEY_ID=aws-access-key
Copy link
Member

Choose a reason for hiding this comment

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

Tiny observation but perhaps aws-access-key could say aws-access-key-id in line with the key name?

Copy link
Member Author

Choose a reason for hiding this comment

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

thanks for your attention to detail @Cleop 🎉

README.md Outdated

The role of the Github application is to
send **notifications** when **events** occur in your repositories. <br />
For example you can get be notified
Copy link
Member

Choose a reason for hiding this comment

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

Typo, either needs to be 'For example you can get be notified' or 'For example you can get be notified'.

README.md Outdated
```
- Define the local environment variables:
Now that you have defined all the necessary
environment variables in your `.env` file, <br /
Copy link
Member

Choose a reason for hiding this comment

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

This <br / is not closed, either close it or remove it 🤔

Copy link
Member Author

Choose a reason for hiding this comment

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

fixed.

@Cleop Cleop removed their assignment Mar 27, 2018
Copy link
Member

@SimonLab SimonLab left a comment

Choose a reason for hiding this comment

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

🎉 looks great, thanks @nelsonic for all the detailed steps

@nelsonic nelsonic requested a review from iteles March 27, 2018 12:09
Copy link
Member

@iteles iteles left a comment

Choose a reason for hiding this comment

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

Looks great! 🎉

@iteles iteles merged commit cbfca91 into master Mar 27, 2018
@nelsonic nelsonic deleted the improve-readme-instructions-issue#35 branch March 27, 2018 16:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants