Browse code

Reduce ansible/ansible README to essentials (#52878)

* Reduce intro to essentials

Dag Wieers authored on 2019/04/05 06:41:53
Showing 1 changed files
... ...
@@ -5,23 +5,9 @@ Ansible
5 5
 *******
6 6
 
7 7
 Ansible is a radically simple IT automation system. It handles
8
-configuration-management, application deployment, cloud provisioning,
9
-ad-hoc task-execution, and multinode orchestration -- including
10
-trivializing things like zero-downtime rolling updates with load
11
-balancers.
12
-
13
-Read the documentation and more at https://ansible.com/
14
-
15
-You can find installation instructions
16
-`here <https://docs.ansible.com/ansible/latest/installation_guide/intro_installation.html>`_ for a
17
-variety of platforms.
18
-
19
-Most users should probably install a released version of Ansible from ``pip``, a package manager or
20
-our `release repository <https://releases.ansible.com/ansible/>`_. `Officially supported
21
-<https://www.ansible.com/ansible-engine>`_ builds of Ansible are also available. Some power users
22
-run directly from the development branch - while significant efforts are made to ensure that
23
-``devel`` is reasonably stable, you're more likely to encounter breaking changes when running
24
-Ansible this way.
8
+configuration management, application deployment, cloud provisioning,
9
+ad-hoc task execution, network automation, and multi-node orchestration. Ansible makes complex
10
+changes like zero-downtime rolling updates with load balancers easy. More information on `the Ansible website <https://ansible.com/>`_.
25 11
 
26 12
 Design Principles
27 13
 =================
... ...
@@ -39,6 +25,21 @@ Design Principles
39 39
 *  Be usable as non-root.
40 40
 *  Be the easiest IT automation system to use, ever.
41 41
 
42
+Use Ansible
43
+===========
44
+
45
+You can install a released version of Ansible via ``pip``, a package manager, or
46
+our `release repository <https://releases.ansible.com/ansible/>`_. See our
47
+`installation guide <https://docs.ansible.com/ansible/latest/installation_guide/intro_installation.html>`_ for details on installing Ansible
48
+on a variety of platforms.
49
+
50
+Red Hat offers supported builds of `Ansible Engine <https://www.ansible.com/ansible-engine>`_.
51
+
52
+Power users and developers can run the ``devel`` branch, which has the latest
53
+features and fixes, directly. Although it is reasonably stable, you are more likely to encounter
54
+breaking changes when running the ``devel`` branch. We recommend getting involved
55
+in the Ansible community if you want to run the ``devel`` branch.
56
+
42 57
 Get Involved
43 58
 ============
44 59
 
... ...
@@ -47,51 +48,35 @@ Get Involved
47 47
    kinds of ways to contribute to and interact with the project,
48 48
    including mailing list information and how to submit bug reports and
49 49
    code to Ansible.
50
-*  All code submissions are done through pull requests to the ``devel`` branch.
51
-*  Feel free to talk to us before making larger changes
50
+*  Join a `Working Group
51
+   <https://github.com/ansible/community/wiki>`_, an organized community devoted to a specific technology domain or platform.
52
+*  Submit proposed a code update through a pull request to the ``devel`` branch.
53
+*  Talk to us before making larger changes
52 54
    to avoid duplicate efforts. This not only helps everyone
53
-   know what's going on, it also helps save time and effort if we decide
55
+   know what is going on, it also helps save time and effort if we decide
54 56
    some changes are needed.
55
-*  Users list:
56
-   `ansible-project <https://groups.google.com/group/ansible-project>`_
57
-*  Development list:
58
-   `ansible-devel <https://groups.google.com/group/ansible-devel>`_
59
-*  Announcement list:
60
-   `ansible-announce <https://groups.google.com/group/ansible-announce>`_
61
-   -- read only
62
-*  irc.freenode.net: #ansible
63
-*  For the full list of Email Lists, IRC channels see the
57
+*  For a list of email lists, IRC channels and Working Groups, see the
64 58
    `Communication page <https://docs.ansible.com/ansible/latest/community/communication.html>`_
65 59
 
66 60
 Branch Info
67 61
 ===========
68 62
 
69
-*  Releases are named after Led Zeppelin songs. (Releases prior to 2.0
70
-   were named after Van Halen songs.)
71
-*  The ``devel`` branch corresponds to the release actively under
72
-   development.
73
-*  The ``stable-2.x`` branches exist for current releases.
74
-*  Various release-X.Y branches exist for previous releases.
63
+*  The ``devel`` branch corresponds to the release actively under development.
64
+*  The ``stable-2.X`` branches correspond to stable releases.
75 65
 *  For information about the active branches see the
76 66
    `Ansible release and maintenance <https://docs.ansible.com/ansible/latest/reference_appendices/release_and_maintenance.html>`_ page.
77
-*  We'd love to have your contributions, read the `Community
78
-   Guide <https://docs.ansible.com/ansible/latest/community>`_ for notes on
79
-   how to get started.
80 67
 
81 68
 Roadmap
82 69
 =======
83 70
 
84
-Based on team and community feedback, an initial roadmap will be published for a major or minor version (ex: 2.0, 2.1).
85
-Subminor versions will generally not have roadmaps published.
86
-
71
+Based on team and community feedback, an initial roadmap will be published for a major or minor version (ex: 2.7, 2.8).
87 72
 The `Ansible Roadmap page <https://docs.ansible.com/ansible/devel/roadmap/>`_ details what is planned and how to influence the roadmap.
88 73
 
89 74
 Authors
90 75
 =======
91 76
 
92 77
 Ansible was created by `Michael DeHaan <https://github.com/mpdehaan>`_
93
-(michael.dehaan/gmail/com) and has contributions from over 4000 users
94
-(and growing). Thanks everyone!
78
+and has contributions from over 4000 users (and growing). Thanks everyone!
95 79
 
96 80
 `Ansible <https://www.ansible.com>`_ is sponsored by `Red Hat, Inc.
97 81
 <https://www.redhat.com>`_