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

Reduce ansible/ansible README to essentials #52878

Open
wants to merge 2 commits into
base: devel
from

Conversation

Projects
None yet
7 participants
@dagwieers
Copy link
Member

dagwieers commented Feb 23, 2019

SUMMARY

A link to the Working Groups was missing. I also reduced the overall amount of information on that first introduction page of our project.

What information would you share with someone that does not know the project already ?
A lot of the information is not essential and covered elsewhere.
In fact I think we can reduce it even more...

ISSUE TYPE
  • Docs Pull Request
COMPONENT NAME

README

@ansibot ansibot removed the stale_ci label Mar 11, 2019

@acozine acozine changed the title Reduce intro to essentials Reduce ansible/ansible README to essentials Mar 11, 2019

Read the documentation and more at https://ansible.com/
You can install a released version of Ansible via ``pip``, a package manager, or
our `release repository <https://releases.ansible.com/ansible/>`_. See our
`installation guide <https://docs.ansible.com/ansible/latest/installation_guide/intro_installation.html>`_ for details on installing Ansible

This comment has been minimized.

@webknjaz

webknjaz Mar 11, 2019

Member

Can we multiline this to make lines shorter?

This comment has been minimized.

@webknjaz

webknjaz Mar 11, 2019

Member

maybe use detached ref mappings?

Power users and developers can run the development
branch directly. It is reasonably stable, but you are more likely to encounter
breaking changes when running the ``devel`` branch. We recommend participating
in the Ansible community if you want to run the development branch - see Get Involved below.

This comment has been minimized.

@webknjaz

webknjaz Mar 11, 2019

Member
Suggested change
in the Ansible community if you want to run the development branch - see Get Involved below.
in the Ansible community if you want to run the development branch see Get Involved below.

This comment has been minimized.

@webknjaz

webknjaz Mar 11, 2019

Member

"Get Involved" could be referenced using a relative anchor

This comment has been minimized.

@acozine

acozine Mar 11, 2019

Contributor

Do relative anchors show up on GitHub?

* All code submissions are done through pull requests to the ``devel`` branch.
* Feel free to talk to us before making larger changes
* Join a `Working Group
<https://github.com/ansible/community/wiki>`_, an organized community devoted to a specific technology domain or platform.

This comment has been minimized.

@webknjaz

webknjaz Mar 11, 2019

Member

Please split this line

Suggested change
<https://github.com/ansible/community/wiki>`_, an organized community devoted to a specific technology domain or platform.
<https://github.com/ansible/community/wiki>`_, an organized community
devoted to a specific technology domain or platform.
Show resolved Hide resolved README.rst
The `Ansible Roadmap page <https://docs.ansible.com/ansible/devel/roadmap/>`_ details what is planned and how to influence the roadmap.

Authors
=======

Ansible was created by `Michael DeHaan <https://github.com/mpdehaan>`_
(michael.dehaan/gmail/com) and has contributions from over 4000 users
(and growing). Thanks everyone!
and has contributions from over 4000 users (and growing). Thanks everyone!

This comment has been minimized.

@webknjaz

webknjaz Mar 11, 2019

Member
Suggested change
and has contributions from over 4000 users (and growing). Thanks everyone!
and has contributions from over 4200 users (and growing). Thanks, everyone!
ad-hoc task-execution, and multinode orchestration -- including
trivializing things like zero-downtime rolling updates with load
balancers.
configuration management, application deployment, cloud provisioning,

This comment has been minimized.

@liquidat

liquidat Mar 11, 2019

Contributor

How about we include network automation and maybe even devops here as well? After all, network automation is a huge topic with Ansible, and many who read "configuration management" will fail to see that this includes network devices.

@ansibot ansibot added the stale_ci label Mar 20, 2019

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.