Tell folks about packaged releases, but encourage usage of git.

12 years ago · bedde394fc
parent e12e724a42
commit bedde394fc
17 changed files with 57 additions and 36 deletions
--- a/YAMLSyntax.html
+++ b/YAMLSyntax.html
@ -245,7 +245,7 @@ languages:
    <p class="pull-right"><a href="#">Back to top</a></p>
    <p>
        &copy; Copyright 2012 Michael DeHaan.<br/>
-      Last updated on Mar 31, 2012.<br/>
+      Last updated on Mar 17, 2012.<br/>
      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.8.<br/>
    </p>
  </div>
--- a/api.html
+++ b/api.html
@ -330,7 +330,7 @@ a conf.d file appropriately or something similar.  Who knows.</p>
    <p class="pull-right"><a href="#">Back to top</a></p>
    <p>
        &copy; Copyright 2012 Michael DeHaan.<br/>
-      Last updated on Mar 31, 2012.<br/>
+      Last updated on Mar 17, 2012.<br/>
      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.8.<br/>
    </p>
  </div>
--- a/examples.html
+++ b/examples.html
@ -318,7 +318,7 @@ a simplified syntax for this.</p>
    <p class="pull-right"><a href="#">Back to top</a></p>
    <p>
        &copy; Copyright 2012 Michael DeHaan.<br/>
-      Last updated on Mar 31, 2012.<br/>
+      Last updated on Mar 17, 2012.<br/>
      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.8.<br/>
    </p>
  </div>
--- a/faq.html
+++ b/faq.html
@ -336,7 +336,7 @@ tasks &#8211; whether for a QA sytem, build system, or anything you can think of
    <p class="pull-right"><a href="#">Back to top</a></p>
    <p>
        &copy; Copyright 2012 Michael DeHaan.<br/>
-      Last updated on Mar 31, 2012.<br/>
+      Last updated on Mar 17, 2012.<br/>
      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.8.<br/>
    </p>
  </div>
--- a/genindex.html
+++ b/genindex.html
@ -160,7 +160,7 @@ s.parentNode.insertBefore(ga, s);
    <p class="pull-right"><a href="#">Back to top</a></p>
    <p>
        &copy; Copyright 2012 Michael DeHaan.<br/>
-      Last updated on Mar 31, 2012.<br/>
+      Last updated on Mar 17, 2012.<br/>
      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.8.<br/>
    </p>
  </div>
--- a/gettingstarted.html
+++ b/gettingstarted.html
@ -132,7 +132,7 @@ s.parentNode.insertBefore(ga, s);
 <li><a class="reference internal" href="#requirements">Requirements</a></li>
 <li><a class="reference internal" href="#developer-requirements">Developer Requirements</a></li>
 <li><a class="reference internal" href="#getting-ansible">Getting Ansible</a><ul>
-<li><a class="reference internal" href="#python-distutils">Python Distutils</a></li>
+<li><a class="reference internal" href="#make-install">Make Install</a></li>
 <li><a class="reference internal" href="#via-rpm">Via RPM</a></li>
 </ul>
 </li>
@ -191,8 +191,8 @@ that you&#8217;ll be talking to the other machines from), you will need:</p>
 <h2>Developer Requirements<a class="headerlink" href="#developer-requirements" title="Permalink to this headline">¶</a></h2>
 <p>For developers, you may wish to have:</p>
 <ul class="simple">
-<li><tt class="docutils literal"><span class="pre">asciidoc</span></tt> (for building manpage documentation)</li>
-<li><tt class="docutils literal"><span class="pre">python-sphinx</span></tt> (for building content for the ansible.github.com project only)</li>
+<li><tt class="docutils literal"><span class="pre">asciidoc</span></tt> (for rebuilding manpage files)</li>
+<li><tt class="docutils literal"><span class="pre">python-sphinx</span></tt> (for rebuilding content for the ansible.github.com docs project only)</li>
 </ul>
 </div>
 <div class="section" id="getting-ansible">
@ -202,11 +202,16 @@ project page:</p>
 <ul class="simple">
 <li><a class="reference external" href="https://github.com/ansible/ansible/downloads">Ansible/downloads</a></li>
 </ul>
-<p>You can also clone the git repository yourself and install Ansible in
-one of two ways:</p>
-<div class="section" id="python-distutils">
-<h3>Python Distutils<a class="headerlink" href="#python-distutils" title="Permalink to this headline">¶</a></h3>
-<p>You can also install Ansible using Python Distutils:</p>
+<p>As the project is still pretty new, you will probably just want to clone
+the git checkout instead, so you can keep up with all of the latest features,
+and also contribute easily back to the project (if you want).
+Instructions for installing from source are below.</p>
+<p>You may also wish to follow the <a class="reference external" href="https://github.com/ansible/">Github project</a> if
+you have a github account.  This is also where we keep the issue tracker for sharing
+bugs or feature ideas.</p>
+<div class="section" id="make-install">
+<h3>Make Install<a class="headerlink" href="#make-install" title="Permalink to this headline">¶</a></h3>
+<p>You can install Ansible using &#8220;make install&#8221;.  This is done through python distutils:</p>
 <div class="highlight-python"><pre>$ git clone git://github.com/ansible/ansible.git
 $ cd ./ansible
 $ sudo make install</pre>
@ -219,13 +224,17 @@ distribution. Until that time you can use the <tt class="docutils literal"><span
 <div class="highlight-python"><pre>$ git clone git://github.com/ansible/ansible.git
 $ cd ./ansible
 $ make rpm
-$ sudo rpm -Uvh ~/rpmbuild/RPMS/noarch/ansible-1.0-1.noarch.rpm</pre>
+$ sudo rpm -Uvh ~/rpmbuild/RPMS/noarch/ansible-*.noarch.rpm</pre>
 </div>
+<p>If you are tracking the upstream source (i.e. git), the RPM revision may not be
+bumped with every source code change.  To get around this, you can use
+rpm <cite>-Uvh</cite> with <cite>&#8211;force</cite> when RPM tells you the package is still at the
+same version.</p>
 </div>
 </div>
 <div class="section" id="your-first-commands">
 <h2>Your first commands<a class="headerlink" href="#your-first-commands" title="Permalink to this headline">¶</a></h2>
-<p>Edit /etc/ansible/hosts and put one or more remote systems in it, for
+<p>Edit (or create) /etc/ansible/hosts and put one or more remote systems in it, for
 which you have your SSH key in <tt class="docutils literal"><span class="pre">authorized_keys</span></tt>:</p>
 <div class="highlight-python"><pre>192.168.1.50
 aserver.example.org
@ -269,7 +278,7 @@ you already have a working infrastructure!</p>
    <p class="pull-right"><a href="#">Back to top</a></p>
    <p>
        &copy; Copyright 2012 Michael DeHaan.<br/>
-      Last updated on Mar 31, 2012.<br/>
+      Last updated on Mar 17, 2012.<br/>
      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.8.<br/>
    </p>
  </div>
--- a/index.html
+++ b/index.html
@ -225,7 +225,7 @@ you with questions about Ansible.</p>
 <li class="toctree-l2"><a class="reference internal" href="gettingstarted.html#requirements">Requirements</a></li>
 <li class="toctree-l2"><a class="reference internal" href="gettingstarted.html#developer-requirements">Developer Requirements</a></li>
 <li class="toctree-l2"><a class="reference internal" href="gettingstarted.html#getting-ansible">Getting Ansible</a><ul>
-<li class="toctree-l3"><a class="reference internal" href="gettingstarted.html#python-distutils">Python Distutils</a></li>
+<li class="toctree-l3"><a class="reference internal" href="gettingstarted.html#make-install">Make Install</a></li>
 <li class="toctree-l3"><a class="reference internal" href="gettingstarted.html#via-rpm">Via RPM</a></li>
 </ul>
 </li>
@ -356,7 +356,7 @@ Puppet Labs, and rPath.  Reach Michael by email <a class="reference external" hr
    <p class="pull-right"><a href="#">Back to top</a></p>
    <p>
        &copy; Copyright 2012 Michael DeHaan.<br/>
-      Last updated on Mar 31, 2012.<br/>
+      Last updated on Mar 17, 2012.<br/>
      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.8.<br/>
    </p>
  </div>
--- a/man.html
+++ b/man.html
@ -194,7 +194,7 @@ examples of these tools in use.</p>
    <p class="pull-right"><a href="#">Back to top</a></p>
    <p>
        &copy; Copyright 2012 Michael DeHaan.<br/>
-      Last updated on Mar 31, 2012.<br/>
+      Last updated on Mar 17, 2012.<br/>
      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.8.<br/>
    </p>
  </div>
--- a/man/ansible-playbook.1.html
+++ b/man/ansible-playbook.1.html
@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>ansible-playbook</title><link rel="stylesheet" href="./docbook-xsl.css" type="text/css" /><meta name="generator" content="DocBook XSL Stylesheets V1.75.2" /></head><body><div xml:lang="en" class="refentry" title="ansible-playbook" lang="en"><a id="id419867"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>ansible-playbook — run an ansible playbook</p></div><div class="refsynopsisdiv" title="Synopsis"><a id="_synopsis"></a><h2>Synopsis</h2><p>ansible-playbook &lt;filename.yml&gt; … [options]</p></div><div class="refsect1" title="DESCRIPTION"><a id="_description"></a><h2>DESCRIPTION</h2><p><span class="strong"><strong>Ansible playbooks</strong></span> are a configuration and multinode deployment system.  Ansible-playbook is the tool
+<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>ansible-playbook</title><link rel="stylesheet" href="./docbook-xsl.css" type="text/css" /><meta name="generator" content="DocBook XSL Stylesheets V1.75.2" /></head><body><div xml:lang="en" class="refentry" title="ansible-playbook" lang="en"><a id="id520082"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>ansible-playbook — run an ansible playbook</p></div><div class="refsynopsisdiv" title="Synopsis"><a id="_synopsis"></a><h2>Synopsis</h2><p>ansible-playbook &lt;filename.yml&gt; … [options]</p></div><div class="refsect1" title="DESCRIPTION"><a id="_description"></a><h2>DESCRIPTION</h2><p><span class="strong"><strong>Ansible playbooks</strong></span> are a configuration and multinode deployment system.  Ansible-playbook is the tool
 used to run them.   See the project home page (link below) for more information.</p></div><div class="refsect1" title="ARGUMENTS"><a id="_arguments"></a><h2>ARGUMENTS</h2><div class="variablelist"><dl><dt><span class="term">
 <span class="strong"><strong>filename.yml</strong></span>
 </span></dt><dd>
--- a/man/ansible.1.html
+++ b/man/ansible.1.html
@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>ansible</title><link rel="stylesheet" href="./docbook-xsl.css" type="text/css" /><meta name="generator" content="DocBook XSL Stylesheets V1.75.2" /></head><body><div xml:lang="en" class="refentry" title="ansible" lang="en"><a id="id522506"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>ansible — run a command somewhere else</p></div><div class="refsynopsisdiv" title="Synopsis"><a id="_synopsis"></a><h2>Synopsis</h2><p>ansible &lt;host-pattern&gt; [-f forks] [-m module_name] [-a args]</p></div><div class="refsect1" title="DESCRIPTION"><a id="_description"></a><h2>DESCRIPTION</h2><p><span class="strong"><strong>Ansible</strong></span> is an extra-simple tool/framework/API for doing 'remote things' over
+<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>ansible</title><link rel="stylesheet" href="./docbook-xsl.css" type="text/css" /><meta name="generator" content="DocBook XSL Stylesheets V1.75.2" /></head><body><div xml:lang="en" class="refentry" title="ansible" lang="en"><a id="id491888"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>ansible — run a command somewhere else</p></div><div class="refsynopsisdiv" title="Synopsis"><a id="_synopsis"></a><h2>Synopsis</h2><p>ansible &lt;host-pattern&gt; [-f forks] [-m module_name] [-a args]</p></div><div class="refsect1" title="DESCRIPTION"><a id="_description"></a><h2>DESCRIPTION</h2><p><span class="strong"><strong>Ansible</strong></span> is an extra-simple tool/framework/API for doing 'remote things' over
 SSH.</p></div><div class="refsect1" title="ARGUMENTS"><a id="_arguments"></a><h2>ARGUMENTS</h2><div class="variablelist"><dl><dt><span class="term">
 <span class="strong"><strong>host-pattern</strong></span>
 </span></dt><dd>
--- a/moduledev.html
+++ b/moduledev.html
@ -394,7 +394,7 @@ Stop by the mailing list to inquire about requirements.</p>
    <p class="pull-right"><a href="#">Back to top</a></p>
    <p>
        &copy; Copyright 2012 Michael DeHaan.<br/>
-      Last updated on Mar 31, 2012.<br/>
+      Last updated on Mar 17, 2012.<br/>
      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.8.<br/>
    </p>
  </div>
--- a/modules.html
+++ b/modules.html
@ -415,7 +415,7 @@ various configuration attributes.  Values include &#8216;installed&#8217;, &#821
    <p class="pull-right"><a href="#">Back to top</a></p>
    <p>
        &copy; Copyright 2012 Michael DeHaan.<br/>
-      Last updated on Mar 31, 2012.<br/>
+      Last updated on Mar 17, 2012.<br/>
      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.8.<br/>
    </p>
  </div>
--- a/patterns.html
+++ b/patterns.html
@ -240,7 +240,7 @@ wildcards:</p>
    <p class="pull-right"><a href="#">Back to top</a></p>
    <p>
        &copy; Copyright 2012 Michael DeHaan.<br/>
-      Last updated on Mar 31, 2012.<br/>
+      Last updated on Mar 17, 2012.<br/>
      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.8.<br/>
    </p>
  </div>
--- a/playbooks.html
+++ b/playbooks.html
@ -530,7 +530,7 @@ Let&#8217;s run a playbook using a parallelism level of 10:</p>
    <p class="pull-right"><a href="#">Back to top</a></p>
    <p>
        &copy; Copyright 2012 Michael DeHaan.<br/>
-      Last updated on Mar 31, 2012.<br/>
+      Last updated on Mar 17, 2012.<br/>
      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.8.<br/>
    </p>
  </div>
--- a/rst/gettingstarted.rst
+++ b/rst/gettingstarted.rst
@ -32,8 +32,8 @@ Developer Requirements

 For developers, you may wish to have:

-* ``asciidoc`` (for building manpage documentation)
-* ``python-sphinx`` (for building content for the ansible.github.com project only)
+* ``asciidoc`` (for rebuilding manpage files)
+* ``python-sphinx`` (for rebuilding content for the ansible.github.com docs project only)


 Getting Ansible
@ -44,19 +44,26 @@ project page:

 * `Ansible/downloads <https://github.com/ansible/ansible/downloads>`_

-You can also clone the git repository yourself and install Ansible in
-one of two ways:
+As the project is still pretty new, you will probably just want to clone
+the git checkout instead, so you can keep up with all of the latest features,
+and also contribute easily back to the project (if you want).  
+Instructions for installing from source are below.

+You may also wish to follow the `Github project <https://github.com/ansible/>`_ if
+you have a github account.  This is also where we keep the issue tracker for sharing
+bugs or feature ideas.

-Python Distutils
-++++++++++++++++

-You can also install Ansible using Python Distutils::
+Make Install
++++++++++++
+
+You can install Ansible using "make install".  This is done through python distutils::

    $ git clone git://github.com/ansible/ansible.git
    $ cd ./ansible
    $ sudo make install

+
 Via RPM
 +++++++

@ -66,12 +73,17 @@ distribution. Until that time you can use the ``make rpm`` command::
    $ git clone git://github.com/ansible/ansible.git
    $ cd ./ansible
    $ make rpm
-    $ sudo rpm -Uvh ~/rpmbuild/RPMS/noarch/ansible-1.0-1.noarch.rpm
+    $ sudo rpm -Uvh ~/rpmbuild/RPMS/noarch/ansible-*.noarch.rpm
+
+If you are tracking the upstream source (i.e. git), the RPM revision may not be 
+bumped with every source code change.  To get around this, you can use
+rpm `-Uvh` with `--force` when RPM tells you the package is still at the
+same version.

 Your first commands
 ```````````````````

-Edit /etc/ansible/hosts and put one or more remote systems in it, for
+Edit (or create) /etc/ansible/hosts and put one or more remote systems in it, for
 which you have your SSH key in ``authorized_keys``::

    192.168.1.50
--- a/search.html
+++ b/search.html
@ -177,7 +177,7 @@ s.parentNode.insertBefore(ga, s);
    <p class="pull-right"><a href="#">Back to top</a></p>
    <p>
        &copy; Copyright 2012 Michael DeHaan.<br/>
-      Last updated on Mar 31, 2012.<br/>
+      Last updated on Mar 17, 2012.<br/>
      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.8.<br/>
    </p>
  </div>
--- a/searchindex.js
+++ b/searchindex.js