From ebd9673ceb72c4d2a4386306796f1961da3f9222 Mon Sep 17 00:00:00 2001 From: Michael DeHaan Date: Thu, 25 Oct 2012 23:17:05 -0400 Subject: [PATCH] Tweak docsite re: resources/contrib page --- docsite/rst/contrib.rst | 80 ++++++++++++--------------------------- docsite/rst/index.rst | 10 +---- docsite/rst/moduledev.rst | 12 ------ docsite/rst/modules.rst | 2 +- 4 files changed, 28 insertions(+), 76 deletions(-) diff --git a/docsite/rst/contrib.rst b/docsite/rst/contrib.rst index 5cef2c0a681..ff26d8d8885 100644 --- a/docsite/rst/contrib.rst +++ b/docsite/rst/contrib.rst @@ -3,10 +3,10 @@ Ansible Resources User contributed playbooks, modules, and articles. This is a small curated list, but growing. Everyone is encouraged to add to this -document, just send in a pull request! +document, just send in a github pull request to docsite/rst/contrib.rst! Ansible Modules -=============== +``````````````` Ansible modules are a way of adding new client-side logic to ansible. They can be written in any language. @@ -29,7 +29,7 @@ Not all modules above yet take advantage of this feature. See the official documentation for more details. Selected Playbooks -================== +`````````````````` `Playbooks `_ are Ansible's configuration management language. It should be easy to write your own @@ -52,7 +52,7 @@ what others have done for reference. - `Fedora `_ Callbacks and Plugins -===================== +````````````````````` The Ansible project has a whole repo devoted to extending ansible with new connection types, logging/event callbacks, and inventory data @@ -62,71 +62,41 @@ even add sound effects. - `Ansible-Plugins `_ Scripts And Misc -================ +```````````````` Ansible isn't just a program, it's also an API. Here's some examples of some clever integrations with the "Runner" and also Playbook APIs, and integrations with other interesting pieces of software. -- `Ansible Vagrant - plugin `_ - dsander -- `Ansible+Vagrant - Tutorial `_ - - mattupstate - -- `virt-install `_ - - skvidal -- `rebooting - hosts `_ - - skvidal -- `uptime (API - demo) `_ - - mpdehaan +- `Ansible Vagrant plugin `_ - dsander +- `Ansible+Vagrant Tutorial `_ - mattupstate - +- `virt-install `_ - skvidal +- `rebooting hosts `_ - skvidal +- `uptime (API demo) `_ - mpdehaan Blogs & Articles -================ +```````````````` -- `HighScalability.com `_ - - mpdehaan -- `ColoAndCloud.com - interview `_ - - mpdehaan -- `dzone `_ - - Mitch Pronschinske -- `Configuration Management With - Ansible `_ - - jp\_mens -- `Shell Scripts As Ansible - Modules `_ - - jp\_mens -- `Ansible Facts `_ - - jp\_mens -- `Infrastructure as - Data `_ - - cocoy -- `Ansible Pull - Mode `_ - - cocoy -- `Exploring Configuration Management With - Ansible `_ - - Palamino DB -- `You Should Consider Using SSH Based Configuration - Management `_ - - LShift Ltd -- `Deploying Flask/uWSGI, Nginx, and - Supervisorctl `_ - - mattupstate -- `Infracoders - Presentation `_ - - Daniel Hall +- `HighScalability.com `_ - mpdehaan +- `ColoAndCloud.com interview `_ - mpdehaan +- `dzone `_ - Mitch Pronschinske +- `Configuration Management With Ansible `_ - jp\_mens +- `Shell Scripts As Ansible Modules `_ - jp\_mens +- `Ansible Facts `_ - jp\_mens +- `Infrastructure as Data `_ - cocoy +- `Ansible Pull Mode `_ - cocoy +- `Exploring Configuration Management With Ansible `_ - Palamino DB +- `You Should Consider Using SSH Based Configuration Management `_ - LShift Ltd +- `Deploying Flask/uWSGI, Nginx, and Supervisorctl `_ - mattupstate +- `Infracoders Presentation `_ - Daniel Hall Disclaimer -========== +`````````` Modules and playbooks here may not be using the latest in Ansible features. When in doubt to the features of a particular version of Ansbile, always consult `ansible.cc `_ and in -particular see `Best -Practices `_ for some tips +particular see `Best Practices `_ for some tips and tricks that may be useful. Ansible is (C) 2012, `Michael DeHaan `_ diff --git a/docsite/rst/index.rst b/docsite/rst/index.rst index 4ca73a5e33c..89900792561 100644 --- a/docsite/rst/index.rst +++ b/docsite/rst/index.rst @@ -56,21 +56,15 @@ with other solutions in your environment. api moduledev -Ansible Resources -````````````````` - -.. toctree:: - :maxdepth: 0 - - contrib Miscellaneous ````````````` -A list of some people using Ansible. +A list of some people using Ansible, and some additional resources. .. toctree:: :maxdepth: 1 who_uses_ansible + contrib diff --git a/docsite/rst/moduledev.rst b/docsite/rst/moduledev.rst index 8e6a19bc0d4..d63dd7b6f6b 100644 --- a/docsite/rst/moduledev.rst +++ b/docsite/rst/moduledev.rst @@ -377,18 +377,6 @@ output formats available: validate it on the `YAML Lint `_ website. -Sharing Your Module -``````````````````` - -If you think your module is generally useful to others, a good place to share it -is in `Ansible Resources `_. This is maintained -as a simple repo with pointers to other github projects. - -Contrib modules here can be implemented in a variety of languages. -We would like to build up as many of these as possible in as many languages as possible. - -`Ansible Mailing List `_ - Getting Your Module Into Core ````````````````````````````` diff --git a/docsite/rst/modules.rst b/docsite/rst/modules.rst index c7ab5b16469..6f33d6f1331 100644 --- a/docsite/rst/modules.rst +++ b/docsite/rst/modules.rst @@ -62,7 +62,7 @@ See :doc:`moduledev`. .. seealso:: - `Ansible Resources (Contrib) `_ + :doc:`contrib` User contributed playbooks, modules, and articles :doc:`examples` Examples of using modules in /usr/bin/ansible