ansible/docs/docsite/rst/dev_guide/index.rst

*********************
Developer Information
*********************

Ansible Developer Guide
=======================

Welcome to the Ansible Developer Guide!

The purpose of this guide is to document all of the paths available to you for interacting and shaping Ansible with code, ranging from developing modules and plugins to helping to develop the Ansible Core Engine via pull requests.

To get started, select one of the following topics.


.. toctree::
   :maxdepth: 1

   overview_architecture
   developing_modules
   developing_modules_general
   developing_modules_documenting
   developing_modules_best_practices
   developing_modules_checklist
   developing_modules_in_groups
   developing_program_flow_modules
   developing_module_utilities
   developing_plugins
   developing_inventory
   developing_core
   developing_python3
   developing_api
   developing_test_pr
   developing_rebasing
   testing
   repomerge
   ../release_and_maintenance
   ../committer_guidelines
   ./style_guide/index
Docs how to test (2nd) (#24094) * Big testing doc refactor * Combine all the testing documentation in to one place to make it easier to find * Convert everything to RST * Create testing_network guide * Create testing landing page * For each section detail "how to run" and "how to extend testing" * More examples * Lots more detail 2017-04-28 08:08:26 +00:00			`*********************`
Dev guide reorg continues (#17732) 2016-09-23 20:48:37 +00:00			`Developer Information`
Docs how to test (2nd) (#24094) * Big testing doc refactor * Combine all the testing documentation in to one place to make it easier to find * Convert everything to RST * Create testing_network guide * Create testing landing page * For each section detail "how to run" and "how to extend testing" * More examples * Lots more detail 2017-04-28 08:08:26 +00:00			`*********************`
Dev guide reorg continues (#17732) 2016-09-23 20:48:37 +00:00
			`Ansible Developer Guide`
Docs how to test (2nd) (#24094) * Big testing doc refactor * Combine all the testing documentation in to one place to make it easier to find * Convert everything to RST * Create testing_network guide * Create testing landing page * For each section detail "how to run" and "how to extend testing" * More examples * Lots more detail 2017-04-28 08:08:26 +00:00			`=======================`
Dev guide reorg continues (#17732) 2016-09-23 20:48:37 +00:00
			`Welcome to the Ansible Developer Guide!`

			`The purpose of this guide is to document all of the paths available to you for interacting and shaping Ansible with code, ranging from developing modules and plugins to helping to develop the Ansible Core Engine via pull requests.`

			`To get started, select one of the following topics.`


			`.. toctree::`
			`:maxdepth: 1`

			`overview_architecture`
			`developing_modules`
Updates to docs for developers (#24034) - Added items to index for TOC - Changed some formatting on overview_architecture - removed some out of date items from developing_modules_general 2017-05-08 16:08:55 +00:00			`developing_modules_general`
			`developing_modules_documenting`
			`developing_modules_best_practices`
			`developing_modules_checklist`
			`developing_modules_in_groups`
			`developing_program_flow_modules`
			`developing_module_utilities`
Dev guide reorg continues (#17732) 2016-09-23 20:48:37 +00:00			`developing_plugins`
			`developing_inventory`
			`developing_core`
Updates to docs for developers (#24034) - Added items to index for TOC - Changed some formatting on overview_architecture - removed some out of date items from developing_modules_general 2017-05-08 16:08:55 +00:00			`developing_python3`
			`developing_api`
			`developing_test_pr`
Initial docs for rebasing PRs. (#19624) 2016-12-21 20:48:41 +00:00			`developing_rebasing`
Updates to docs for developers (#24034) - Added items to index for TOC - Changed some formatting on overview_architecture - removed some out of date items from developing_modules_general 2017-05-08 16:08:55 +00:00			`testing`
Fix all RST errors for docs/docsite/rst (#20005) * developing_modules.rst is now in dev_guide, sync changes and delete the old version * Cleaner RST & formatted code * Tidyup roadmaps * Link to repomerge * Pull in abadger's fixes From https://github.com/ansible/ansible/compare/docs-code-block-fixes?expand=1 * Clean docsite/rst (apart from ROADMAP 2017-01-07 19:38:52 +00:00			`repomerge`
Improve release and development cycle documentation This commit: - Adds a table highlighting the status of each version and provides a link to each major release's changelog - Re-inforces how stable versions are maintained and for how long - Moves this documentation out of the developer tree (this is interesting for users too!) while keeping a link there. 2017-07-21 20:05:02 +00:00			`../release_and_maintenance`
Fix all RST errors for docs/docsite/rst (#20005) * developing_modules.rst is now in dev_guide, sync changes and delete the old version * Cleaner RST & formatted code * Tidyup roadmaps * Link to repomerge * Pull in abadger's fixes From https://github.com/ansible/ansible/compare/docs-code-block-fixes?expand=1 * Clean docsite/rst (apart from ROADMAP 2017-01-07 19:38:52 +00:00			`../committer_guidelines`
Added style guide (#24310) * Added style guide * Fixed index 2017-05-04 20:25:13 +00:00			`./style_guide/index`