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

minor documentation edits and typo fixes #214

Merged
merged 1 commit into from
May 8, 2019
Merged

Conversation

meichstedt
Copy link
Contributor

@meichstedt meichstedt commented May 3, 2019

What type of PR is this?
/kind documentation

What this PR does / why we need it:
This contains some minor edits for readability of documentation, as well as a couple typo fixes.

Which issue(s) this PR fixes:
I'm not sure an issue is warranted.

Special notes for your reviewer:
Some of the docs pages are pretty inconsistent with respect to addressing the reader: they use "you can do X" or "here we see Y" arbitrarily. I'd love to converge towards "you", addressing the reader directly. Let me know if I can take on this effort as well.

Does this PR introduce a user-facing change?:
NONE

Copy link
Member

@fabianbaier fabianbaier left a comment

Choose a reason for hiding this comment

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

While doing this, could we maybe give https://github.com/kudobuilder/kudo/blob/880ec0bb642d2b5bd9720d36ec4c5142fd229726/docs/Comparison.md also some love in this PR?

@meichstedt
Copy link
Contributor Author

@fabianbaier Can do, but I'll focus on typography and wording for now. I don't know enough about the specifics yet so I can't really improve the content.

Copy link
Contributor

@joerg84 joerg84 left a comment

Choose a reason for hiding this comment

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

These are great improvements! Thanks @meichstedt !

@runyontr runyontr merged commit b8edd86 into master May 8, 2019
@meichstedt meichstedt deleted the me/docs-improvements branch May 14, 2019 13:20
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.

6 participants