Skip to content
This repository was archived by the owner on May 27, 2024. It is now read-only.

update the README to actually have some contents #270

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
+49 −3
Open

update the README to actually have some contents #270

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 49 additions & 3 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,52 @@
# Welcome to Ansible Examples!

Ansible Examples
----------------
First and foremost, for those who don't know, [Ansible](https://www.ansible.com)
is a radically simple IT automation platform that makes your applications and
systems easier to deploy. It allows you and your team to avoid writing scripts
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
Copy link

Choose a reason for hiding this comment

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

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

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
Copy link

Choose a reason for hiding this comment

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

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.

any native protocol to any device.

This repository contains examples and best practices for building Ansible Playbooks.
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)
Copy link

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?

first.

Now that's out of the way, let's dive right in.

# Ansible Examples

This repository contains examples and recommended practices for creating
[Ansible
Copy link

Choose a reason for hiding this comment

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

extraneous linebreak

Playbooks](https://docs.ansible.com/ansible/latest/user_guide/playbooks_intro.html).

Here you will find various examples of common use cases that a modern [Systems
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
Copy link

Choose a reason for hiding this comment

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

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.

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.
Copy link

Choose a reason for hiding this comment

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

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
Copy link

Choose a reason for hiding this comment

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

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

automating. Inside of each of these subdirectories you will find a `README.md`
that will provide information and context about it's contents.
Copy link

Choose a reason for hiding this comment

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

Suggested change
that will provide information and context about it's contents.
that will provide information and context about its contents.



## Feedback

If you have any issues with the examples contained here, suggestions, or
requests for new examples, please file an Issue ticket here on GitHub. This
repository is powered by the
[Ansible Community](https://www.ansible.com/community), we invite you to come
join us!