ansible/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2024-09-14 20:13:21 +02:00
Code Releases Activity

Enhance meta-docs on... contributing to docs.

Browse source 
- Update FAQ entry to refer to docsite README and reduce redundancy.

- Add additional info to docsite README: Sphinx building, link to module
  documentation reference.
This commit is contained in:
Ches Martin 2013-07-22 17:20:38 +07:00
parent a7a82c79c0
commit b35fc42d36
2 changed files with 16 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

24
docsite/latest/README.md
View file

@ -1,18 +1,20 @@
Homepage and documentation source for the Ansible
=================================================
Homepage and documentation source for Ansible
=============================================
This project hosts the source behind [ansibleworks.com/docs](http://www.ansibleworks.com/docs/)
Contributions to the documentation are welcome. To make changes, submit a pull request
that changes the restructured text files in the "rst/" directory only, and Michael can
do a docs build and push the static files.
that changes the reStructuredText files in the "rst/" directory only, and Michael can
do a docs build and push the static files. If you wish to verify output from the markup
such as link references, you may [install Sphinx] and build the documentation by running
`make viewdocs` from the `ansible/docsite/latest` directory.
If you do not want to learn RST format (ReStructured Text), you can also file issues
on the documentation project.
If you do not want to learn the reStructuredText format, you can also [file issues] about
documentation problems on the Ansible GitHub project.
Note that module documentation can actually be generated from a DOCUMENTATION docstring
in the modules directory, so corrections to modules written as much need to be made
in the main project in the module source, rather than in the documentation for the module.
Note that module documentation can actually be [generated from a DOCUMENTATION docstring][module-docs]
in the modules directory, so corrections to modules written as such need to be made
in the module source, rather than in docsite source.
Author
======
@ -21,3 +23,7 @@ Michael DeHaan -- michael.dehaan@gmail.com
[http://michaeldehaan.net](http://michaeldehaan.net/)
[install Sphinx]: http://sphinx-doc.org/install.html
[file issues]: https://github.com/ansible/ansible/issues
[module-docs]: http://www.ansibleworks.com/docs/moduledev.html#documenting-your-module

3
docsite/latest/rst/faq.rst
View file

@ -165,8 +165,7 @@ Yes! See `AnsibleWorks.com <http://ansibleworks.com>`_ or email `info@ansiblewo
How do I submit a change to the documentation?
++++++++++++++++++++++++++++++++++++++++++++++
Great question! Documentation for the Ansible project is kept in `Github <https://github.com/ansible/ansible/tree/devel/docsite/latest/rst>`_ in restructured text format. Simply send in a pull request for changes, or file a ticket if you found an error but do not have time to submit
a change request. Thanks!
Great question! Documentation for Ansible is kept in the main project git repository, and complete instructions for contributing can be found in the docs README `viewable on GitHub <https://github.com/ansible/ansible/tree/devel/docsite/latest#readme>`_. Thanks!
I don't see my question here
++++++++++++++++++++++++++++