Skip to content

Commit

Permalink
Docsite formatting
Browse files Browse the repository at this point in the history
  • Loading branch information
mpdehaan committed Sep 26, 2014
1 parent 7e520c4 commit ffee9a8
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 13 deletions.
3 changes: 1 addition & 2 deletions hacking/module_formatter.py
Original file line number Diff line number Diff line change
Expand Up @@ -210,8 +210,7 @@ def process_module(module, options, env, template, outputname, module_map):
if doc is None:
return "SKIPPED"

if "core" in module:
print "CORE"
if "/core/" in fname:
doc['core'] = True
else:
doc['core'] = False
Expand Down
31 changes: 20 additions & 11 deletions hacking/templates/rst.j2
Original file line number Diff line number Diff line change
Expand Up @@ -101,25 +101,34 @@ Examples
{% endfor %}
{% endif %}

Developers, Testers, and Bug Reporting
--------------------------------------

{% set repo = "https://github.com/ansible/ansible-modules-extras" %}
{% set tracker = "https://github.com/ansible/ansible-modules-extras/issues" %}
{% if core %}
{% set repo = "https://github.com/ansible/ansible-modules-core" %}
{% set tracker = "https://github.com/ansible/ansible-modules-core/issues" %}
{% endif %}
This source of this module is hosted on GitHub in the `{{ repo }} <{{ repo }}>`_ repo.

This is a Core Module
---------------------

This source of this module is hosted on GitHub in the `ansible-modules-core <http://github.com/ansible/ansible-modules-core>`_ repo.

If you believe you have found a bug in this module, and are already running the latest stable or development version of Ansbile, first look in the issue tracker at `{{ tracker }} <{{ tracker }}>`_ to see if a bug has already been filed. If not, we would be greatful if you would file one.
If you believe you have found a bug in this module, and are already running the latest stable or development version of Ansbile, first look in the `issue tracker at github.com/ansible/ansible-modules-core <http://github.com/ansible/ansible-modules-core>`_ to see if a bug has already been filed. If not, we would be greatful if you would file one.

Should you have a question rather than a bug report, inquries are welcome on the `ansible-project google group <https://groups.google.com/forum/#!forum/ansible-project>` or on Ansible's "#ansible" channel, located on irc.freenode.net. Development oriented topics should instead use the similar `ansible-devel google group <https://groups.google.com/forum/#!forum/ansible-project>`_.

Documentation updates for this module can also be edited directly by submitting a pull request to the module source code, just look for the "DOCUMENTATION" block in the source tree.

{% if not core %}
This is a "core" ansible module, which means it will recieve slightly higher priority for all requests than those in the "extras" repos.

{% else %}

This is an Extras Module
------------------------

This source of this module is hosted on GitHub in the `ansible-modules-extras <http://github.com/ansible/ansible-modules-extras>`_ repo.

If you believe you have found a bug in this module, and are already running the latest stable or development version of Ansbile, first look in the `issue tracker at github.com/ansible/ansible-modules-extras <http://github.com/ansible/ansible-modules-extras>`_ to see if a bug has already been filed. If not, we would be greatful if you would file one.

Should you have a question rather than a bug report, inquries are welcome on the `ansible-project google group <https://groups.google.com/forum/#!forum/ansible-project>` or on Ansible's "#ansible" channel, located on irc.freenode.net. Development oriented topics should instead use the similar `ansible-devel google group <https://groups.google.com/forum/#!forum/ansible-project>`_.

Documentation updates for this module can also be edited directly by submitting a pull request to the module source code, just look for the "DOCUMENTATION" block in the source tree.

Note that this module is designated a "extras" module. Non-core modules are still fully usuable, but may recieve slightly lower response rates for issues and pull requests.
Popular "extras" modules may be promoted to core modules over time.
Expand Down

0 comments on commit ffee9a8

Please sign in to comment.