-
Notifications
You must be signed in to change notification settings - Fork 7.7k
update the README to actually have some contents #270
base: master
Are you sure you want to change the base?
Conversation
Signed-off-by: Adam Miller <[email protected]>
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 for kicking this off!! Few line edits.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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 |
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.
extraneous linebreak
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
*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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
that will provide information and context about it's contents. | |
that will provide information and context about its contents. |
Signed-off-by: Adam Miller [email protected]