centersl/ansible-docs
1
0
Fork 0
mirror of https://github.com/ansible/ansible-documentation.git synced 2026-03-28 13:39:00 +07:00
Code Issues Packages Projects Releases Wiki Activity
54,771 Commits 10 Branches 190 Tags
da170cbb57c965acaa1ede3db4a1e11200e4aed5
Commit Graph

36 Commits

Author SHA1 Message Date
Prithvi Ramakrishnan
cb1f9d6ac6 Remove string conversion action documentation reference (#2120) 2024-11-18 10:50:40 -05:00
Andrew Klychkov
3551f1999b docs/docsite/rst/dev_guide/developing_program_flow_modules.rst: avoid using aliases (#1539) 
* docs/docsite/rst/dev_guide/developing_program_flow_modules.rst: don't use aliases

* Update docs/docsite/rst/dev_guide/developing_program_flow_modules.rst

Co-authored-by: Sandra McCann <samccann@redhat.com>

* Update docs/docsite/rst/dev_guide/developing_program_flow_modules.rst

Co-authored-by: flowerysong <junk+github@flowerysong.com>

---------

Co-authored-by: Sandra McCann <samccann@redhat.com>
Co-authored-by: flowerysong <junk+github@flowerysong.com>
 2024-07-02 12:28:02 +02:00
Matt Martz
048e4d468a Add documentation for module option context (#1057) 
* Add documentation for module option context

* suggestion

Co-authored-by: Don Naro <dnaro@redhat.com>

* Expand docs to indicate context is not used by core

---------

Co-authored-by: Don Naro <dnaro@redhat.com>
 2024-02-02 13:43:22 -05:00
ildjarnisdead
6893bb3c09 Update developing_program_flow_modules.rst (#819) 
Typo
depecated -> deprecated
 2023-11-13 10:58:27 -05:00
Harish Rao
95f1d2d016 Changed it's to it is in all .rst files (#491) 2023-10-18 14:45:16 -04:00
Biresh Biswas
8f085111b4 Replacing filename with file name (#502) 2023-10-04 16:36:20 -04:00
Deepshri M
ad16d8b283 Fix for : Replace all occurrences of via to with #459 (#479) 
* Update via to with

* Update doc as per suggestion
 2023-10-03 10:08:39 -04:00
Deepshri M
a4a2bad07f Update 'For instance' to 'For example' (#472) 2023-10-02 11:15:14 -04:00
zu
b5721a84cd Replace controller with control node (#352) 
Co-authored-by: Sandra McCann <samccann@redhat.com>
Co-authored-by: Don Naro <dnaro@redhat.com>
 2023-09-13 15:45:05 -04:00
Matt Clay
58461bc204 Remove outdated note on relative imports in docs (#79873) 2023-02-01 12:23:59 -05:00
Evgeni Golov
7ab3de7ee8 correct examples to use removed_from_collection not collection_name (#79803) 2023-01-25 09:36:03 +00:00
JaroslavKlech
3ae2f97d4a iss#55935: Documents missing internal parameters and polishes 'Intern… (#79118) 
Co-authored-by: Jaroslav Klech <jklech@redhat.com>
Co-authored-by: Sloane Hertel <19572925+s-hertel@users.noreply.github.com>
 2022-11-17 14:05:38 -05:00
Mazen Ramadan
fbd98cd824 Docs: Replace Latin terms in the dev_guide #78997 (#79005) 2022-10-03 16:42:37 -04:00
Samuel Gaist
19fce0527a docs - Use code-block to format code examples in Developer Guide (#75849) 
Fixes #75663
 2021-10-04 13:55:00 -07:00
Alicia Cozine
b57444af14 Rebased pr73824 (#73934) 
Co-authored-by: Eugene <k.evgen61@gmail.com>
Co-authored-by: Alicia Cozine <acozine@users.noreply.github.com>
 2021-03-17 16:07:38 -04:00
Matt Clay
607af05d36 Fix syntax errors detected by rstcheck. 
The errors occur when using sphinx >= 2.0.0.
 2021-01-27 16:32:11 -08:00
Felix Fontein
01d207a3e3 Improve argument spec documentation (#72335) 
* Link to argument spec documentation from 'Creating a module'.

* Use items instead of sub-headings.

* Update deprecation information.

* Document conditional requirements.

* Document supports_check_mode and add_file_common_args.

* Add deprecation examples.

* Re-add word.

* Improve title.

* Fix RST formatting, add conditional dependency section starter.
 2020-11-04 18:17:46 +01:00
Guillaume Vincent
1a06587f3b Fix typo in the documentation (#71701) 
Fix typo in the documentation: casting instead of casing
 2020-09-10 10:49:59 -05:00
Andrew Klychkov
7bfeed3e24 Docsite: replace Latin phrases to English (#71588) 
Replace Latin phrases like "e.g." and "i.e." and "etc." with English phrases. 

* Update docs/docsite/rst/community/committer_guidelines.rst
* Update docs/docsite/rst/dev_guide/developing_modules_documenting.rst
* Update docs/docsite/rst/dev_guide/developing_program_flow_modules.rst
* Update docs/docsite/rst/dev_guide/module_lifecycle.rst
* Update docs/docsite/rst/user_guide/intro_inventory.rst
* Update docs/docsite/rst/user_guide/playbooks_loops.rst
* Update docs/docsite/rst/user_guide/playbooks_reuse.rst
* Update docs/docsite/rst/dev_guide/platforms/aws_guidelines.rst
* Update docs/docsite/rst/dev_guide/testing.rst
* Update docs/docsite/rst/dev_guide/testing_integration.rst
* Update docs/docsite/rst/porting_guides/porting_guide_2.5.rst
* Update docs/docsite/rst/reference_appendices/faq.rst
 2020-09-03 14:47:57 -05:00
Alicia Cozine
29b20bd1b1 DOCS: Mentions ansible-base, adds collections pointers to Community and Dev Guides (#71480) 2020-09-01 12:25:37 -04:00
Ken Dreyer
318d5606c1 doc: explain default "required" value for argument_spec (#68678) 2020-04-06 16:07:30 -04:00
kaorihinata
3ca4580cb4 Allow no_log=False to silence the no_log warnings for module parameters (#64733) 
As AnsibleModule._log_invocation is currently implemented, any parameter
with a name that matches PASSWORD_MATCH triggers the no_log warning as a
precaution against parameters that may contain sensitive data, but have not
been marked as sensitive by the module author.

This patch would allow module authors to explicitly mark the aforementioned
parameters as not sensitive thereby bypassing an erroneous warning message,
while still catching parameters which have not been marked at all by the
author.

Adds tests for various no_log states including True, False, and None (as
extracted by AnsibleModule._log_invocation) when applied to an argument with
a name that matches PASSWORD_MATCH.

Fixes: #49465 #64656
 2020-01-09 16:47:57 -05:00
Michael Prokop
b33ae14949 doc: fix typos (#62852) 2019-09-26 10:18:29 -04:00
James Cassell
8bca160363 add vfat to selinux special_context_filesystems (#59823) 
vfat is the format of the /boot/efi partition on UEFI hosts and does
not support SELinux labels

add an environment variable for this config option
 2019-08-12 14:45:27 -04:00
Toshio Kuratomi
edafa71f42 Developer documentation update involving module invocation (#55747) 
* Update docs for the 2.7 change to AnsiballZ which invokes modules with one
  less Python interpreter

* Add a section on how module results are returned and on trust between modules, action plugins, and the executor.

* Update docs/docsite/rst/dev_guide/developing_program_flow_modules.rst

Co-Authored-By: abadger <a.badger@gmail.com>
 2019-05-01 18:52:22 -05:00
Alicia Cozine
9a76441c02 rewrite of the developer guide, part 1 (#45179) 
* rewrite of the developer guide, part 1
 2018-09-07 08:57:36 -05:00
Matt Martz
1663b64e18 Allow subspec defaults to be processed when the parent argument is not supplied (#38967) 
* Allow subspec defaults to be processed when the parent argument is not supplied

* Allow this to be configurable via apply_defaults on the parent

* Document attributes of arguments in argument_spec

* Switch manageiq_connection to use apply_defaults

* add choices to api_version in argument_spec
 2018-05-07 11:23:13 -05:00
Alicia Cozine
4b52a54e18 Reduce warnings (#39254) 
* removes FAQ links; no entries exist for linked config settings

* fixes various anchors and links

* addresses abadger comments, thanks

* marks orphan pages, avoids TOC errors

* adds links for remote_tmp setting to FAQ
 2018-04-25 11:18:52 -07:00
Toshio Kuratomi
9faf7b949e Fix places in docs that refer to modules without namespace 
We've namespaced all plugin docs.  Change the docs to reflect that
 2018-04-18 08:43:34 -07:00
scottb
381359a8f8 Doc build warning/broken link clean-a-palooza (#37382) 
* Doc build warning/broken link clean-a-palooza, WIP commit 1.

* Fixed broken anchor

* Fixing additional broken links; converting from doc to ref.

* Fix anchor
 2018-03-14 12:44:21 -07:00
scottb
373b1dcf59 Core Docs Refactor and Redesign (#36067) 
* Docs refactor as outlined in https://github.com/ansible/proposals/issues/79. Moves content into 'guides'; refactors TOC; fixes CSS; design tweaks to layout and CSS; fixes generated plugin, CLI and module docs to fix links accodingly; more.

* Adding extra blank line for shippable
 2018-02-13 07:23:55 -08:00
Michihito Shigemura
78fd326908 Fix typo in dev_guide/developing_program_flow_modules 2017-10-02 16:10:45 -04:00
Toshio Kuratomi
8de05d3752 [WIP] Documentation: Ansible-2.4 no longer supports Python-2.4 and Python-2.5 (#22721) 
* Documentation: Ansible-2.4 no longer supports Python-2.4 and Python-2.5
* Switched to bullet points to enhance readability.
 2017-03-16 18:49:29 -07:00
John R Barker
7df31aaca1 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 11:38:52 -08:00
Toshio Kuratomi
1be3ac36df Fix block highlighting 
Found out that we change the default highlighting to yaml.
So explicitly mark python code blocks as such.
 2017-01-06 12:37:51 -08:00
Brian Coca
57f8b791d6 consolidated docs 
point to new doc locations
removed non existing dirs
 2017-01-06 09:16:59 -05:00