1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2024-09-14 20:13:21 +02:00
community.general/docs/docsite
Yaacov Zamir 48922660fe New model manageiq manageiq user (#26641)
* ManageIQ: manageiq_user module, module utils and doc_fragment

ManageIQ is an open source management platform for Hybrid IT.

This change is adding:
- manageiq_user module, responsible for user management in ManageIQ
- manageiq utils
- manageiq doc_fragment

* Handle import error

* Use formatting options

* group parameter is required

* changed doesn't need to be an attribute

* resource dictionary should contain values which isn't None

* move from monitoring to remote-management

* Use ManageIQ nameing convention

* Do not set defauts in arguments

* Use idempotent state parameter instead of action

* Check import error in the manageiq util class

* Update the miq documentation

* rename the connection configuration from miq to manageiq_connection

* All messeges start with non cap, fix typos, add examples, rename vars

* more typos fixes

* Make sure we insert only strings to logs by using % formating

* use suboptions keyword for the manageiq connection

* do not log the managiq connection struct (it include sensitive information like username and password)

* add missing from __future__

* ahh, wrong no-log line

* Use sub options
2017-08-03 10:49:47 -04:00
..
_static consolidated docs 2017-01-06 09:16:59 -05:00
_themes/srtd Switch Adobe tracking off staging. 2017-04-17 13:36:31 -07:00
js/ansible consolidated docs 2017-01-06 09:16:59 -05:00
man consolidated docs 2017-01-06 09:16:59 -05:00
rst New model manageiq manageiq user (#26641) 2017-08-03 10:49:47 -04:00
rst_common consolidated docs 2017-01-06 09:16:59 -05:00
.gitignore Initial ansible-test sanity docs. (#26775) 2017-07-14 14:24:45 +01:00
.nojekyll consolidated docs 2017-01-06 09:16:59 -05:00
favicon.ico consolidated docs 2017-01-06 09:16:59 -05:00
jinja2-2.9.6.inv Enable intersphinx for python stdlib and jinja2 2017-04-25 12:26:40 -07:00
keyword_desc.yml added order doc for inventory keyword 2017-05-16 15:54:19 -04:00
Makefile Initial ansible-test sanity docs. (#26775) 2017-07-14 14:24:45 +01:00
Makefile.sphinx Use correct path for docsite src (rst/) 2017-01-13 18:14:33 -05:00
modules.js consolidated docs 2017-01-06 09:16:59 -05:00
python2-2.7.13.inv Enable intersphinx for python stdlib and jinja2 2017-04-25 12:26:40 -07:00
python3-3.6.1.inv Enable intersphinx for python stdlib and jinja2 2017-04-25 12:26:40 -07:00
README.md consolidated docs 2017-01-06 09:16:59 -05:00
variables.dot consolidated docs 2017-01-06 09:16:59 -05:00

Homepage and documentation source for Ansible

This project hosts the source behind docs.ansible.com

Contributions to the documentation are welcome. To make changes, submit a pull request that changes the reStructuredText files in the "rst/" directory only, and the core team 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 directory.

To include module documentation you'll need to run make webdocs at the top level of the repository. The generated html files are in docsite/htmlout/.

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 such need to be made in the module source, rather than in docsite source.

To install sphinx and the required theme, install pip and then "pip install sphinx sphinx_rtd_theme"