-
Notifications
You must be signed in to change notification settings - Fork 14
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
[issue-139] Improve documentation #166
Conversation
8e5b34e
to
79c5202
Compare
Thank you @rsearls - this is, simply put, great. It'll take some time to review the changes, but such an improvement will add a huge value, and therefore I pinned this PR to the release milestone. |
/retest |
1 similar comment
/retest |
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.
Thanks again @rsearls for this PR.
This is a huge and valuable contribution to the project, so kudos to your commitment.
Most of my comments are just about typos or minor things, like formatting to have a better rendering. A few of them are about the contents.
Feel free to let me know what you think.
b3ae4e8
to
b47563e
Compare
Should rebase on main, first. |
b47563e
to
dbb7f91
Compare
/retest |
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.
Hi @rsearls - thanks for addressing my comments.
I've dropped a couple more about minor issues, and one about the two tables which are documenting provisioners, those should be merged into one.
Fell free to let me know what you think.
dbb7f91
to
9fcf8e8
Compare
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.
Please review this major rewrite and restructuring of ./README.md
and provisioners/README.md and provide feedback particularly on
correctness of the information.
Part of #139