update the README to actually have some contents #270
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Adam Miller <admiller@redhat.com>
jillr
reviewed
Apr 15, 2020
| or custom code to deploy and update your applications, systems, and various | ||
| classifications of network attached devices. Ansible allows you to automate in a | ||
| language that approaches plain English, with no agents to install on remote | ||
| systems and use native protocols based on device type such as SSH for |
There was a problem hiding this comment.
Suggested change
| systems and use native protocols based on device type such as SSH for | |
| systems, and uses native protocols based on device type such as SSH for |
| language that approaches plain English, with no agents to install on remote | ||
| systems and use native protocols based on device type such as SSH for | ||
| UNIX-style operating systems, WinRM for Windows systems, REST APIs (httpapi) | ||
| for REST API appliances, and many many more. Ansible is capable of speaking to |
There was a problem hiding this comment.
Suggested change
| for REST API appliances, and many many more. Ansible is capable of speaking to | |
| for REST API appliances, and many many more. Ansible is capable of speaking |
I think I've interpreted this one correctly.
| If you are not familiar with Ansible and have arrived here looking for a place | ||
| to start, please check out the [Getting | ||
| Started | ||
| Guide](https://docs.ansible.com/ansible/latest/user_guide/playbooks_conditionals.html) |
There was a problem hiding this comment.
The markdown does render correctly, but there's a lot of line breaks going on here.
Is playbook conditionals really what you meant to link to?
| # Ansible Examples | ||
|
|
||
| This repository contains examples and recommended practices for creating | ||
| [Ansible |
| Administrator](https://en.wikipedia.org/wiki/System_administrator) or | ||
| [DevOps](https://en.wikipedia.org/wiki/DevOps) Practitioner may find themselves | ||
| needing to automate. The goal of this repository and its contents are to provide | ||
| *examples* that are functional and offer recommended guideance and how to |
There was a problem hiding this comment.
Suggested change
| *examples* that are functional and offer recommended guideance and how to | |
| *examples* that are functional and offer recommended guidance for how to |
The and isn't really wrong, but there's a lot of them in this sentence and I feel this reads better, personally.
| *examples* that are functional and offer recommended guideance and how to | ||
| accomplish certain tasks using common patterns. This repository is not | ||
| inherently meant to provide "Production Ready" automation workflows, even though | ||
| the content might be of that quality, it's certainly not a goal. |
There was a problem hiding this comment.
Suggested change
| the content might be of that quality, it's certainly not a goal. | |
| the content might be of that quality, but rather to give you a good starting place to work from. |
YMMV, I'd rather tell folks at least one thing that this is for, along with the things it is not for.
| ## Subdirectories | ||
|
|
||
| In this repository you will find a series of subdirectories, each of these is | ||
| named after the topic or technology they aim to provide and example of |
There was a problem hiding this comment.
Suggested change
| named after the topic or technology they aim to provide and example of | |
| named after the topic or technology they aim to provide an example of |
| In this repository you will find a series of subdirectories, each of these is | ||
| named after the topic or technology they aim to provide and example of | ||
| automating. Inside of each of these subdirectories you will find a `README.md` | ||
| that will provide information and context about it's contents. |
There was a problem hiding this comment.
Suggested change
| that will provide information and context about it's contents. | |
| that will provide information and context about its contents. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Signed-off-by: Adam Miller admiller@redhat.com