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.

Sign up for GitHub

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

Jump to bottom

Doc/improve readability #90

Merged
merged 3 commits into from
Apr 4, 2019
Merged

Doc/improve readability #90

merged 3 commits into from
Apr 4, 2019

Conversation

cvmiert
Copy link
Contributor

@cvmiert cvmiert commented Apr 4, 2019 •
edited by vox-eve
Loading

Reviewers: @fabiotc @rdohms @WyriHaximus @renatomefi @frankkoornstra @agustingomes @cvmiert

Type

Please specify the type of changes being proposed:

Q A
Documentation? yes
Dockerfile change? no
Build feature? no
Apply CVE Patch? no
Remove CVE Patch? no

Changelog

  • Update reference to current alpine versions
  • Improve README.md readability

@cvmiert cvmiert added the Documentation This issue or pull request is related to documentation and written guidelines label Apr 4, 2019
WyriHaximus
WyriHaximus approved these changes Apr 4, 2019
View reviewed changes
Copy link
Member

@WyriHaximus WyriHaximus left a comment

Choose a reason for hiding this comment

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

👍

renatomefi
renatomefi suggested changes Apr 4, 2019
View reviewed changes
Copy link
Contributor

@renatomefi renatomefi left a comment

Choose a reason for hiding this comment

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

Thanks for this 🎉

So what was the reason for the dots and new lines in the markdown?
If it's the md linter I'd suggest to put it in the circleci config thus it won't happen again!

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
Clara van Miert added 2 commits April 4, 2019 17:18
Improve README.md readability
98ab602 
Enhance phrasing, punctuation and wrap lines earlier.
Add reference to Nginx configuration ADR
061e218
@cvmiert cvmiert force-pushed the doc/improve-readability branch from 29856a2 to 061e218 Compare April 4, 2019 15:19
@cvmiert
Copy link
Contributor Author

cvmiert commented Apr 4, 2019

So what was the reason for the dots and new lines in the markdown?
If it's the md linter I'd suggest to put it in the circleci config thus it won't happen again!

It wasn't any linter, but this just reads a lot more pleasantly regardless of your IDE settings 😉

@cvmiert cvmiert merged commit 40939ed into master Apr 4, 2019
@cvmiert cvmiert deleted the doc/improve-readability branch April 4, 2019 15:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@renatomefi renatomefi renatomefi approved these changes

@WyriHaximus WyriHaximus WyriHaximus approved these changes

@agustingomes agustingomes Awaiting requested review from agustingomes

@fabiotc fabiotc Awaiting requested review from fabiotc

@frankkoornstra frankkoornstra Awaiting requested review from frankkoornstra

@rdohms rdohms Awaiting requested review from rdohms

Assignees
No one assigned
Labels
Documentation This issue or pull request is related to documentation and written guidelines
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@cvmiert @WyriHaximus @renatomefi