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

100 Commits

Author SHA1 Message Date
Andrew Klychkov
c268b80df5 Update developing_modules_documenting.rst (#2551) 2025-04-23 11:19:56 -04:00
Andrew Klychkov
6e8c4bd633 Module format and doc: tidy up (#2502) 
* developing_modules_documenting.rst: tidy up

Co-authored-by: Don Naro <dnaro@redhat.com>
Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com>
Co-authored-by: Sandra McCann <samccann@redhat.com>
 2025-04-17 13:59:09 +01:00
Sandra McCann
7082b5ded5 address broken links in dev and appendices sections (#2402) 
* fix some broken links

* malformed link

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

Co-authored-by: Abhijeet Kasurde <akasurde@redhat.com>

* Apply suggestions from code review

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

---------

Co-authored-by: Abhijeet Kasurde <akasurde@redhat.com>
Co-authored-by: Don Naro <dnaro@redhat.com>
 2025-02-24 17:14:23 +00:00
mabezi
9076624351 add note about arguments in shebang in modules (#1718) 
* add note about arguments in shebang in modules

* update note about arguments in shebang in modules

* move notes about shebang in one warning
 2024-08-21 10:19:46 +01:00
Felix Fontein
85eb8610ca Fix list. 2024-05-20 15:24:03 +02:00
Felix Fontein
1d0b46bba5 Document attributes (#1130) 
* Markup fixes.

* option-name is not a field.

* Document module attributes.
 2024-03-20 16:53:26 -04:00
Felix Fontein
c7bd238228 Improve module developing documenation for deprecation and linking (#943) 
* 'why' isn't optional, and there are more ways to reference entities.

* Mention that P(...) can reference roles as well.

* Mention how to deprecate action plugins.

* Improve language.

Co-authored-by: Don Naro <dnaro@redhat.com>
 2023-12-07 13:14:53 -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
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
Felix Fontein
98b10aadc0 Use semantic markup (#65) 2023-07-13 16:39:58 -04:00
Christinanik251
5a44acc704 Update P() semantic markup example (#80464) 2023-04-10 14:30:11 -04:00
Felix Fontein
4029da9a9f Semantic markup docs (#80240) 
Co-authored-by: Alicia Cozine <acozine@users.noreply.github.com>
Co-authored-by: Don Naro <dnaro@redhat.com>
Co-authored-by: Sandra McCann <samccann@redhat.com>
Co-authored-by: Matt Clay <matt@mystile.com>
 2023-04-06 16:46:03 +01:00
Kristian Heljas
02c49ffe60 Encourage true/false for module documentation (#80060) 
Co-authored-by: Felix Fontein <felix@fontein.de>
 2023-03-02 13:46:02 -05:00
Brian Coca
8b032150a4 document adjacent docs (sidecar) (#79056) 
* Update docs/docsite/rst/dev_guide/developing_locally.rst
Co-authored-by: Don Naro <dnaro@redhat.com>
 2023-01-12 11:47:07 -05:00
Felix Fontein
733a767948 Add basic docs on how to create a collection docsite with antsibull-docs. (#78387) 2022-08-04 12:28:48 -04:00
Desmond Obisi
c9a341902b Document choice to use Ansible Project in copyright lines (#78164) 
Co-authored-by: Sviatoslav Sydorenko <wk.cvs.github@sydorenko.org.ua>
 2022-07-13 16:46:04 -04:00
Sandra McCann
ef2fe6823c add collection pr review checklist (#77661) 
Co-authored-by: Emmanuel Ugwu <32464178+ugwutotheeshoes@users.noreply.github.com>
Co-authored-by: Andrew Klychkov <aaklychkov@mail.ru>
 2022-05-04 11:11:10 -04:00
Sandra McCann
665e3dc629 remove outdated note on limitations of R() in module docs (#76736) 2022-01-12 03:07:37 -08:00
Felix Fontein
a734da5e82 Restore documentation on M() and R() (#76284) 
* Undo most of bf9944266c, add note on where R() does not work.
Co-authored-by: Brian Scholer <1260690+briantist@users.noreply.github.com>
 2021-11-11 15:26:26 -05:00
Brian Scholer
4abc669c24 Update module documentation about ref links (#76088) 
* Update module documentation about ref links
 2021-10-27 14:23:45 -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
Lydie
bf9944266c Issue 73792: Removed mentions of R() and M() (#74708) 
* 73792: Removed mentions of R and M
 2021-05-14 14:48:21 -05:00
Bill Nottingham
34c9ed8a28 Product-related updates. (#74454) 2021-04-27 16:19:57 -05:00
Abhijeet Kasurde
8d499bbc83 Update Kubernetes collection name in docs (#74440) 2021-04-27 19:00:03 +05:30
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
Felix Fontein
76604397cb Mention that C(...) should be used for inline code. (#73312) 2021-01-26 10:48:47 -06:00
Felix Fontein
73aa571305 Make sure to mention collection version for version_added as well. (#73270) 2021-01-18 14:53:10 -05:00
Felix Fontein
270385f949 Remove 'type: complex' from the example, and mention that it should be avoided. (#73171) 2021-01-13 14:01:32 -05:00
Evgeni Golov
57c2cc7c77 correct the reST rendering of the R() note (#72896) 2020-12-08 16:46:09 +01:00
Andrew Klychkov
73bed95ead Docsite: add reference to Style guide (#71694) 2020-09-10 10:17:13 -04:00
esmersmith
a34043c6be Changed all_modules references to list_of_collections in the documentation (#71656) 2020-09-09 11:43:40 -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
Andrew Klychkov
bfba0ffc45 Docsite: improve developing_modules_documenting.rst (#71590) 
* Docsite: improve developing_modules_documenting.rst

* add necessary dots to returns descriptions
 2020-09-02 09:26:42 -04: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
Abhijeet Kasurde
606604bb97 Add warning about copyright year change (#71251) 
To simplify project administration and avoid any legal issues,
add a warning in the docs. This reflects - https://github.com/ansible/ansible/issues/45989#issuecomment-423635622 and fixes: #45989

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
 2020-08-17 15:44:06 -05:00
Toshio Kuratomi
fb144c4414 Update ansible doc formats (#71070) 
* Fix tty_ify bugs and refactor

* Move tty_ify() and supporting attributes to the DocCLI class as that's
  the only thing using it.
* Add unittest for the code.
* Fix a bug where the substitution macros can be detected when they are
  a part of another word.
* Add support for L(), R(), and HORIZONTALLINE which were added to the
  website docs many years ago.

* Update test/units/cli/test_doc.py

Co-authored-by: Matt Clay <matt@mystile.com>

Co-authored-by: Matt Clay <matt@mystile.com>
 2020-08-05 10:53:25 -07:00
Sandra McCann
83f6e4850b document FQCN for M() and :seealso: in DOCUMENTATION blocks (#70245) 
* document FQCN for M() in DOCUMENTATION blocks

* add note about c
 2020-06-29 11:16:59 -05:00
Sandra McCann
c9c8cd34b2 added documentation for R() (#69832) 
* Updated docs/docsite/rst/dev_guide/developing_modules_documenting.rst, added documentation for R()
* added link to how to add anchors, anchor, and clarification on when to use each option

Co-authored-by: John R Barker <john@johnrbarker.com>
Co-authored-by: Alicia Cozine <879121+acozine@users.noreply.github.com>
 2020-06-16 11:50:50 -05:00
Brian Coca
062e780a68 starting metadata sunset (#69454) 
* starting metadata sunset

 - purged metadata from any requirements
 - fix indent in generic handler for yaml content (whey metadata display was off)
 - make more resilient against bad formed docs
 - removed all metadata from docs template
 - remove metadata from schemas
 - removed mdata tests and from unrelated tests

Co-authored-by: Felix Fontein <felix@fontein.de>
Co-authored-by: Rick Elrod <rick@elrod.me>
 2020-06-04 21:01:46 -04:00
Wojciech Sciesinski
49e7f9afe2 Link the testing documentation to the module documenting page (#67248) 2020-02-10 15:30:04 -05:00
Sandra McCann
4dd2513371 add info on creating doc fragments in a collection (#67171) 
* add info on creating doc fragments in a collection
Co-authored-by: Alicia Cozine <879121+acozine@users.noreply.github.com>
 2020-02-10 10:23:28 -06: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
Evgeni Golov
057e137998 clarify returned value of RETURN nlock (#65724) 2019-12-12 17:12:38 -06:00
Felix Fontein
0bf9146b29 Document 'elements' for module option and return value documentation. (#64075) 2019-11-04 15:21:07 -05:00
Sandra McCann
bdd0fac606 add note about collection links (#63346) 2019-10-11 08:27:26 -05:00
Sam Doran
041c52d629 Add info about layering properties 2019-09-12 18:55:13 -07:00
Sam Doran
5deb01c84d Remove suggestion to go caving 2019-09-12 18:55:13 -07:00
Sam Doran
9b348e690c Improve documentation on doc fragments 
Add information and examples on how to use additional properites from a doc fragment
 2019-09-12 18:55:13 -07:00