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

786 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
Yacht Shaver
6267d1a67b Recommend madbg instead of epdb (#2428) 
epdb doesn't work anymore in Python 3.13 because it requires telnetlib
which was removed from Python's stdlib in 3.13
 2025-03-20 16:38:26 -04:00
Sandra McCann
dbae0ce87d fix label warnings (#2417) 
* fix broken links

* fix some more label problems

* Apply suggestions from code review

Co-authored-by: Felix Fontein <felix@fontein.de>

---------

Co-authored-by: Felix Fontein <felix@fontein.de>
 2025-03-20 16:37:10 -04:00
Abhijeet Kasurde
20511dd878 Update module developement (#2427) 
* Update module developement

* Updated developer guide for module development to work with
  collection and PYTHONPATH

Fixes: #2374

Signed-off-by: Abhijeet Kasurde <Akasurde@redhat.com>

* Apply suggestions from code review

Co-authored-by: Don Naro <dnaro@redhat.com>
Signed-off-by: Abhijeet Kasurde <Akasurde@redhat.com>

---------

Signed-off-by: Abhijeet Kasurde <Akasurde@redhat.com>
Co-authored-by: Don Naro <dnaro@redhat.com>
 2025-03-20 16:36:48 -04:00
Andrew Klychkov
350ef3df2c testing_sanity.rst: improvement (#2441) 
* testing_sanity.rst: improvement

* Add collection specific remarks

* Change suggested
 2025-03-18 11:26:23 -04: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
Felix Fontein
d8c36a014f Fix YAML syntax, adjust more code block languages (#2408) 
* Fix broken YAML, or adjust code block type.

* Normalize code block type.
 2025-02-14 22:06:37 +01:00
Don Naro
7eb7a3a8d2 Update RST files to specify codeblock language attributes (#2382) 
* Update RST files to specify codeblock language attributes

Co-authored-by: Ganesh Hubale <25399590+ganeshhubale@users.noreply.github.com>
Co-authored-by: 🇺🇦 Sviatoslav Sydorenko (Святослав Сидоренко) <wk.cvs.github@sydorenko.org.ua>
Co-authored-by: Felix Fontein <felix@fontein.de>

* change lexer names to fix ci

* yaml is yaml not ini

* Update docs/docsite/rst/network/user_guide/network_debug_troubleshooting.rst

Co-authored-by: Felix Fontein <felix@fontein.de>

* yamllint codeblock

* Update docs/docsite/rst/network/dev_guide/developing_resource_modules_network.rst

Co-authored-by: Felix Fontein <felix@fontein.de>

* yamlgit add .

* Update docs/docsite/rst/network/dev_guide/developing_resource_modules_network.rst

Co-authored-by: Felix Fontein <felix@fontein.de>

* Update docs/docsite/rst/network/dev_guide/developing_resource_modules_network.rst

Co-authored-by: Felix Fontein <felix@fontein.de>

* Update docs/docsite/rst/network/dev_guide/developing_resource_modules_network.rst

Co-authored-by: Felix Fontein <felix@fontein.de>

* Update docs/docsite/rst/network/dev_guide/developing_resource_modules_network.rst

Co-authored-by: Felix Fontein <felix@fontein.de>

* Update docs/docsite/rst/network/dev_guide/developing_resource_modules_network.rst

Co-authored-by: Felix Fontein <felix@fontein.de>

* Update docs/docsite/rst/network/user_guide/network_debug_troubleshooting.rst

Co-authored-by: 🇺🇦 Sviatoslav Sydorenko (Святослав Сидоренко) <wk.cvs.github@sydorenko.org.ua>

* Update docs/docsite/rst/network/dev_guide/developing_resource_modules_network.rst

Co-authored-by: 🇺🇦 Sviatoslav Sydorenko (Святослав Сидоренко) <wk.cvs.github@sydorenko.org.ua>

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

Co-authored-by: 🇺🇦 Sviatoslav Sydorenko (Святослав Сидоренко) <wk.cvs.github@sydorenko.org.ua>

* Update docs/docsite/rst/network/user_guide/network_debug_troubleshooting.rst

Co-authored-by: 🇺🇦 Sviatoslav Sydorenko (Святослав Сидоренко) <wk.cvs.github@sydorenko.org.ua>

* Update docs/docsite/rst/os_guide/intro_bsd.rst

Co-authored-by: 🇺🇦 Sviatoslav Sydorenko (Святослав Сидоренко) <wk.cvs.github@sydorenko.org.ua>

---------

Co-authored-by: Ganesh Hubale <ganeshhubale03@gmail.com>
Co-authored-by: Ganesh Hubale <25399590+ganeshhubale@users.noreply.github.com>
Co-authored-by: 🇺🇦 Sviatoslav Sydorenko (Святослав Сидоренко) <wk.cvs.github@sydorenko.org.ua>
Co-authored-by: Felix Fontein <felix@fontein.de>
 2025-02-12 18:53:35 +01:00
Ganesh Hubale
8e331e4b16 fix(style-guide): Add definition for "ID" abbreviation in spelling and word choice guide (#2332) 
- Added entry for "ID" (Identification/Identifier) to the spelling and word choice guide.
- Clarified correct usage as "ID" (all uppercase) and specified avoiding variations like "Id" or "id".
- Provided examples and reasoning for consistent capitalization.

Resolves: ansible/ansible-documentation#2326

Signed-off-by: Ganesh Hubale <ganeshhubale03@gmail.com>
 2025-01-10 13:39:10 -05:00
Akira Yokochi
22a4625c42 fix file name to execution-environment.yml (#2240) 
* fix file name to execution-environment.yml

* fix syntax
 2024-12-10 10:31:29 -05:00
Sandra McCann
3a135cf952 fix bad formating (#2192) 
* fix bad formating

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

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

---------

Co-authored-by: Don Naro <dnaro@redhat.com>
 2024-11-19 08:07:44 +00:00
Sandra McCann
7f11306526 Update some info on distribution servers (#2119) 
* update some links

* remove galax details and leave it to galaxy docs
 2024-11-18 10:51:42 -05:00
Prithvi Ramakrishnan
cb1f9d6ac6 Remove string conversion action documentation reference (#2120) 2024-11-18 10:50:40 -05:00
Conner Crosby
fab962d1e1 Fix the misspelled word 'not' (#2161) 2024-11-16 19:04:31 +01:00
Sandra McCann
8c244c3e0b add note and link for galaxy.yml details (#2092) 2024-11-07 13:46:05 -05:00
Sandra McCann
ef72400cc2 Remove ansible-test sanity from local module development (#2034) 
* Remove ansible-test sanity from local module development

* Update docs/docsite/rst/dev_guide/developing_modules_general.rst
 2024-10-24 15:00:11 -04:00
Sandra McCann
d693f43ba7 add example of extending ansible_facts (#2040) 
* add example of extending ansible_facts

* Apply suggestions from code review

Co-authored-by: Felix Fontein <felix@fontein.de>

---------

Co-authored-by: Felix Fontein <felix@fontein.de>
 2024-10-24 14:38:45 -04:00
Abhijeet Kasurde
495d91595f Remove unsupported API example (#1939) 
* Python API example is unsupported and difficult to maintain with each
  new release.

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
 2024-10-15 19:10:46 +01:00
Felix Fontein
f9cd50b68a Remove no longer applicable part. (#1970) 2024-10-03 11:07:41 +02:00
林博仁 Buo-ren Lin
dce75072fa many: Fix title case of Git references (#1938) 
* many: Fix title case of Git references

Currently many references of the Git software don't use title case, this
patch fixes them while leaving those that should remain lowercase
intact:

* `git` command call in code blocks.
* Git references in changelog entries should stay consistent with the revision title.

Fixes #1935.

Signed-off-by: 林博仁(Buo-ren Lin) <buo.ren.lin@gmail.com>

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

Fix command markup.

Co-authored-by: Felix Fontein <felix@fontein.de>

* Update hacking/README.md

Also fix title case of Python.

Co-authored-by: Felix Fontein <felix@fontein.de>

---------

Signed-off-by: 林博仁(Buo-ren Lin) <buo.ren.lin@gmail.com>
Co-authored-by: Felix Fontein <felix@fontein.de>
 2024-09-25 07:32:34 +02:00
Andrew Klychkov
9f3e3f4b7c Change Getting started EE guide reference to point to the relevant location (#1877) 2024-09-12 14:10:58 +02:00
Andrew Klychkov
bf86a30bef Replace communication links with a link to communication guide, part 2 (#1864) 
* Replace old communication refs with Communication guide ref or forum

* Update docs/docsite/rst/community/documentation_contributions.rst

Co-authored-by: Felix Fontein <felix@fontein.de>

---------

Co-authored-by: Felix Fontein <felix@fontein.de>
 2024-09-12 09:41:36 +02:00
Brian Coca
1500fc2790 Correct information about plugin enabling (#1760) 
* Correct information about plugin enabling

* Apply suggestions from code review

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

---------

Co-authored-by: Don Naro <dnaro@redhat.com>
 2024-09-11 18:10:34 +01: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
Matthias Kunnen
e2137b19a5 Update integration test guide docker flag usage (#1731) 
* Update integration test guide docker flag usage

The integration guide linked to a file in the devel branch that gets out-of-sync with the actual supported images on the user's system.
Instead, we now instruct the user to run the help flag to get the list of supported images that are actually present on their system.

* Point users to the right section in ansible-test integration --help
 2024-08-07 09:11:35 +01: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
taso
5f172fdbd9 fix Ansible architecture docs (#1637) 
I fixed example Inventory  ini format file contains '---' used in Yaml
 2024-06-25 10:02:05 +01:00
Andrew Klychkov
91a9b483c5 developing_collections_migrating.rst: update (#1605) 
* developing_collections_migrating.rst: update

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

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

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

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

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

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

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

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

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

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

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

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

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

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

* Mention old collection to update FQCN

---------

Co-authored-by: Don Naro <dnaro@redhat.com>
Co-authored-by: Sandra McCann <samccann@redhat.com>
 2024-06-21 11:24:47 -04:00
Abhijeet Kasurde
678e113aa7 Update unit test document (#1597) 
* Update unit test document

Fixes: ansible/ansible#83034

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>

* Apply suggestions from code review

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

---------

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
Co-authored-by: Don Naro <dnaro@redhat.com>
 2024-06-20 16:40:10 -04:00
Sandra McCann
4fd8c58945 clarify how to verify collection-level docs (#1589) 
* clarify how to verify collection-level docs

* Update docs/docsite/rst/community/documentation_contributions.rst
 2024-06-13 14:23:03 -04:00
Andrew Klychkov
bd24f0cb29 Fix 2024-05-28 10:24:29 +02:00
Andrew Klychkov
738f805044 Requesting a collection: replace overview links 2024-05-28 09:13:02 +02:00
Felix Fontein
85eb8610ca Fix list. 2024-05-20 15:24:03 +02:00
xszabo3
fd3495af63 Integrate ansible-creator and devtools into the developing collections guide (#1302) 
* doc: integrate ansible-creator in developing_collections_creating.rst

* doc: corrections based on feedback

* doc: highlight ansible-creator in note

* doc: corrections based on review

* doc: move ansible-creator section, rename anchor

* doc: rewrite ADT note based on suggestion

* doc: change links from github to readthedocs
 2024-05-02 15:44:03 -04:00
xszabo3
186be84399 Fix typos in style guide (#1368) 
* doc: fix external link typo in style guide

* doc: remove extra colons from style guide
 2024-05-01 17:21:04 -04:00
Don Naro
499f415508 Merge pull request #1258 from Devids10/paramiko_contradictions 
MUNI_TECH_WRITERS: Paramiko contradictions, issue #1042
 2024-04-25 11:05:02 +01:00
Don Naro
e92e87a033 Update docs/docsite/rst/dev_guide/developing_plugins.rst 
Co-authored-by: Maxwell G <maxwell@gtmx.me>
 2024-04-22 11:49:54 +01:00
Dávid Németh
63d711a37a fix: mentioned errors in the pull request 2024-04-18 17:00:31 +02:00
Dávid Németh
9e7ec7a21c feat: remove depricated smart connection description in connection plugins 2024-04-09 13:47:52 +02:00
Zhaohui Mei
f08e36711f Update developing_modules_general.rst 
Remove extra characters
 2024-03-21 23:00:04 +08: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
Aaron R
e5b359c3a1 Update testing_units_modules.rst (#1210) 
Broken link from - https://rbcs-us.com/documents/Why-Most-Unit-Testing-is-Waste.pdf

Which redirected to - https://www.rexblack.com/documents/Why-Most-Unit-Testing-is-Waste.pdf

New link to - https://drive.google.com/file/d/1BC67QxdwZ9Y48GAsD8xVxkbqu4znCCHq/view

Link found on new domain - https://www.rexblack.com/articles
 2024-03-20 16:37:57 -04:00
Sandra McCann
482ed2aea2 Add link to antsibull-docs docsite (#1198) 2024-03-13 16:36:47 -04:00
Sloane Hertel
39e1e29453 Clarify documentation about empty collections vs collection skeletons (#1180) 
* Clarify documentation about empty collections vs collection skeletons

* Update docs/docsite/rst/dev_guide/developing_collections_creating.rst
 2024-03-07 14:36:22 -05:00
Felix Fontein
a4cb511c64 Remove/update incorrect docs building documentation (#1128) 
* MODULES= and PLUGINS= haven't worked since ansible-base 2.10.

* MODULES= no longer exists.

* Fix dash.

* Remove no longer correct parts.

* Mention --docker option.
 2024-02-20 13:46:12 +01:00
Brian Coca
f557b292ed Alternatives is plural 2024-02-06 10:00:04 -05: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
Sandra McCann
0e6d9c67d8 remove outdated ansible/community links (#913) 
---------

Co-authored-by: Felix Fontein <felix@fontein.de>
Co-authored-by: Andrew Klychkov <aaklychkov@mail.ru>
 2024-02-02 12:41:23 -05:00
Sumanth Lingappa
940152cdf7 added gather_facts/(yes/no) (#1003) 
* added `gather_facts/(yes/no)`

Co-authored-by: Don Naro <dnaro@redhat.com>
 2024-01-15 14:27:57 -05:00