45f9af1fd4
Backport hacktoberfest 3 ( #79069 )
...
* Docs: true/false with boolean values in docsite/rst/playbook_guide (#78958 )
(cherry picked from commit 173ddde126#79009 )
Fixes #79006
(cherry picked from commit f0cc70f9e1#79013 )
fixes #78999 by removing Latin usage in network docs
(cherry picked from commit 8d665a1a8e#78984 )
(cherry picked from commit ea04d05a1e#79011 )
(cherry picked from commit 8f4133b514
3 years ago
b5d8c954b8
Backport hacktoberfest 4 ( #79070 )
...
* docs: replace latin terms with english in the reference_appendices (#79010 )
(cherry picked from commit 4d3c12ae9e#79008 )
(cherry picked from commit 367cdae3b2#78980 )
* Adding FQCN community.postgresql. to postgresql modules
(cherry picked from commit 56285b1d2b#79037 )
* Docs: Add code-block wrappers to code examples
(cherry picked from commit 63b5fc4b8d#78959 )
(cherry picked from commit f7c01bc866#79042 )
* Adding code blocks wrapper
(cherry picked from commit 3a788314a2#79045 )
Authored-by: Shade Alabsa <shadealabsa@microsoft.com>
(cherry picked from commit 3fc3371463#79040 )
* fixed some docs to properly display code blocks
Co-authored-by: Shade Alabsa <shadealabsa@microsoft.com>
(cherry picked from commit 25a770de37#79047 )
(cherry picked from commit 35700f57cc#79032 , #79033 ) (#79048 )
(cherry picked from commit 680bf029b157f22529cb
3 years ago
7077ea7f95
Backport hactoberfest 1 ( #79065 )
...
* apt_key, fix example indentation
Co-authored-by: Matt Clay <matt@mystile.com>
(cherry picked from commit cee9872605#78966 )
* Docs: Add code-block wrappers to code examples: testing_documentation.rst
List of changed files:
- docs/docsite/rst/dev_guide/testing_documentation.rst
* Fix: match whitespace convention of other occurences
(cherry picked from commit 538b99781f#78962 (#78972 )
(cherry picked from commit 01484cdc68#78968 )
(cherry picked from commit 1db75a41bf#78963 (#78969 )
* added code-blocks according to #78963
* Update testing.rst, added newlines
(cherry picked from commit 446406a0c8#78970 )
* Docs: Add code-block wrappers to code examples in style_guide
List of changed files:
- docs/docsite/rst/dev-guide/style_guide/index.rst
- docs/docsite/rst/dev-guide/style_guide/basic_rules.rst
(cherry picked from commit 3dc0c2135e#78971 Update module_lifecycle.rst (#78974 )
* Update module_lifecycle.rst
(cherry picked from commit 93c2cb2b8e#78965 Adding the code-block to prevent the translation (#78979 )
* Adding the code-block to prevent the translation
(cherry picked from commit 9afb37eda6#78977 )
* fix issue #78976
(cherry picked from commit 1b922b42dd#78985 )
(cherry picked from commit 56c48d1c45#78957 )
(cherry picked from commit fb8c2daf46#78951 )
Replaced http link with rst version - issue https://github.com/ansible/ansible/issues/78914
(cherry picked from commit dc2d15fca4#78952 )
Fixes #78914
(cherry picked from commit 919c449256#78953 )
(cherry picked from commit ba32642538#78954 )
(cherry picked from commit 5137cb16e9#78934 )
(cherry picked from commit 5b333c9665
3 years ago
484a671c5e
Fixes broken links. For the github links this was where references to in the URL are stale due to the default branch in the linked repository now being . While github does have the functionality of dropping you on the default branch (via an HTTP 302 redirect) when it does not recognize the branch you are trying to reach, the fact that most of these links work is more of a coincidence than reliance on a github feature. Also removes unnecessary whitespace where found. ( #78638 )
3 years ago
f6fb402d1f
Update guide_vultr.rst ( #77665 )
4 years ago
a1af1d94cd
vmware: Migrate VMware Scenario Guides ( #76640 )
...
Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
4 years ago
2767a4cf4a
docs - remove broken link in ACI scenario guide ( #76940 )
4 years ago
a1d0e60703
Fixed documentation: "[a] ini file" -> "an ini file" ( #76627 )
4 years ago
601d66c7e5
k8s: Migrated scenario guides to collection ( #75249 )
...
Kubernetes scenario guides are moved to
``kubernetes.core`` collection.
Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
4 years ago
e5967c02f5
Fix typos in docs ( #76526 )
4 years ago
0cec4d1cfc
remove aws from the azure note ( #76518 )
4 years ago
0df60f3b61
per marketing request - add note for AAP on Azure availability ( #76512 )
4 years ago
64506c7d15
Docs: Change note for rackspace cloud guide ( #75898 )
...
* Fix rackspace cloud guide docs
* Fix syntax error
4 years ago
9a4346bae3
Docs: Moves the AWS Scenario Guide out of the main docs ( #74704 )
...
* removes AWS scenario guide, moving to collection
* first attept to replace TOC entries
* not sure what I did, but saving it
* updates TOCs to reflect new location of aws guide
* reinstates original page as a stub
* adds links to new location for AWS guide, updates header
Co-authored-by: Alicia Cozine <acozine@users.noreply.github.com>
4 years ago
c2fa71c4e8
Fix various typos in documentation ( #75662 )
...
* docs/docsite/rst/dev_guide/developing_modules_general_aci.rst: fix typos
* docs/docsite/rst/dev_guide/testing/sanity/no-get-exception.rst: fix typos
* docs/docsite/rst/dev_guide/testing_units_modules.rst: fix typos
* docs/docsite/rst/network/dev_guide/developing_resource_modules_network.rst: fix typos
* docs/docsite/rst/porting_guides/porting_guide_2.0.rst: fix typos
* docs/docsite/rst/porting_guides/porting_guide_2.10.rst: fix typos
* docs/docsite/rst/porting_guides/porting_guide_2.4.rst: fix typos
* docs/docsite/rst/porting_guides/porting_guide_3.rst: fix typos
* docs/docsite/rst/porting_guides/porting_guide_4.rst: fix typos
* docs/docsite/rst/reference_appendices/glossary.rst: fix typos
* docs/docsite/rst/reference_appendices/release_and_maintenance.rst: fix typos
* docs/docsite/rst/scenario_guides/vmware_rest_scenarios/collect_information.rst: fix typos
* docs/docsite/rst/scenario_guides/vmware_rest_scenarios/vm_tool_information.rst: fix typos
* docs/docsite/rst/scenario_guides/vmware_scenarios/vmware_inventory_vm_attributes.rst: fix typos
* docs/docsite/rst/user_guide/playbooks_debugger.rst: fix typos
* docs/docsite/rst/user_guide/playbooks_filters.rst: fix typos
* docs/docsite/rst/user_guide/windows_performance.rst: fix typos
* docs/docsite/rst/scenario_guides/vmware_scenarios/vmware_inventory_vm_attributes.rst: fix typos
4 years ago
3c3e30a610
Docs: Add Matrix as a chat option ( #75406 )
4 years ago
549d258c30
Update guide_aws.rst ( #75375 )
...
Update Links in AWS Guide.
4 years ago
13c28664ae
Docs: talk about AWX or the Platform, not Tower ( #74952 )
...
* updates Tower page to talk about RHAAP
* updates scenario guide Tower references
* updates Tower references to use AWX and/or RHAAP
* more scenario guides fixes
* fix CI failures
* Update docs/docsite/rst/porting_guides/porting_guide_2.8.rst
* removes tower link
* for 2.8, still mention Tower along with AWX and RHAAP
* aws guides should be updated in the collection, where they now exist
Co-authored-by: Alicia Cozine <acozine@users.noreply.github.com>
4 years ago
7f6edd78f9
Move Docker scenario guide to community.docker. ( #74736 )
...
The scenario guide has already been added to community.docker in
ansible-collections/community.docker#140
5 years ago
acf09e56a2
Update inventory script references from c.g to ansible-community/contrib-scripts. ( #74905 )
5 years ago
80e7e1a17c
Due to the takeover of freenode we're moving to a different irc network. ( #74775 )
...
* Due to the takeover of freenode we're moving to a different irc network.
* Our channels updated to point at the same channel name on libera.chat
* Some links went to webchat.freenode.net. At this time, libera.chat
doesn't point you to an official webchat client so I changed these to
https://libera.chat . (kiwi irc does work with libera.chat so that
could be another option).
* In general, I used the name irc.libera.net for link names and
https://libera.chat for link targets. This is because the irc service
is hosted on irc.libera.chat but the project web server is hosted on
libera.chat. (This appears to also be true for freenode but we were
using http://irc.freenode.net which doesn't seem to work. Oops).
* Removed http://irc.freenode.net from the linkcheck exceptions.
linkcheck was actually correct to flag that as invalid (should have
been http://frenode.net instead).
* Looks like hte important people in #yaml are now in libera.chat
* Link to where contributors should get help
Add a link target and then link to where contributors should get support
for developing groups of modules.
* Update docs/docsite/rst/dev_guide/developing_modules_in_groups.rst
Co-authored-by: Felix Fontein <felix@fontein.de>
Co-authored-by: John R Barker <john@johnrbarker.com>
Co-authored-by: Felix Fontein <felix@fontein.de>
5 years ago
fa15d35cb1
Update AWS guides with new SDK and Python requirements ( #74585 )
...
The 2.0 collection releases will introduce new Python requirements
and a new SDK support policy
5 years ago
8d499bbc83
Update Kubernetes collection name in docs ( #74440 )
5 years ago
ddfc648d37
Update VMware library installation docs ( #71219 )
...
Depending upon OS/distro, please use pip/pip3.
5 years ago
6e56e72d99
vmware: Add a note about known issue ( #73273 )
...
Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
Co-authored-by: Sandra McCann <samccann@redhat.com>
Co-authored-by: Alicia Cozine <879121+acozine@users.noreply.github.com>
5 years ago
9369bd6ca1
correct how to install Docker SDK for Python ( #74288 )
...
* docs: correct guide for the latest Docker SDK for Python
Co-authored-by: Felix Fontein <felix@fontein.de>
Co-authored-by: Sandra McCann <samccann@redhat.com>
Co-authored-by: Daeseok Youn <daeseok.youn@navercorp.com>
Co-authored-by: Alicia Cozine <879121+acozine@users.noreply.github.com>
5 years ago
c888705493
Add note on infoblox inventory script. ( #73676 )
5 years ago
fa05af8321
Fixing ad-hoc commands #73636 ( #73646 )
5 years ago
ae241b407a
Update guide_azure.rst ( #73030 )
...
Co-authored-by: Abhijeet Kasurde <akasurde@redhat.com>
Co-authored-by: Alicia Cozine <879121+acozine@users.noreply.github.com>
5 years ago
c9f28c1735
Rewrite Docker scenario guide ( #73069 )
5 years ago
b6360dc5e0
VMware: scenario guide for vmware_tools connection plugin ( #72080 )
...
* VMware: scenario guide for vmware_tools connection plugin
Scenario doc to guide user about the usage of vmware_tools
using connection plugin.
Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
* review comments
Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
5 years ago
fe65144a4a
vmware: Using env variable for custom SSL path ( #72273 )
...
When validate_certs is True and user has custom SSL
certificate path, user can use ``REQUESTS_CA_PATH``
in ``environment`` parameter of task to specify this path.
Fixes: https://github.com/ansible-collections/community.vmware/issues/49
Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
5 years ago
02658d7bf8
k8s: Scenario guides ( #72095 )
...
* Start Kubernetes Scenario guides for users
* K8S inventory scenario guide
Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
5 years ago
af7fd0f79d
doc: use FQCN for vmware_rest examples
...
Use the collection name + the module name for clarity.
5 years ago
c72e2ee675
import of the vmware_rest documentation ( #72090 )
...
Co-authored-by: Jill R <4121322+jillr@users.noreply.github.com>
5 years ago
2b79cd2c0f
Fix typos ( #72072 )
5 years ago
760334303b
vmware: Add docs for filters ( #71670 )
...
Add a scenario guide for filters in VMware documentation
Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
5 years ago
c36e939414
Fixed invalid urls inside guide_packet.rst and collections_using.rst ( #71705 )
...
* Fixed invalid urls inside guide_packet.rst and collections_using.rst
* Reverted fix for collections_using.rst
5 years ago
a34043c6be
Changed all_modules references to list_of_collections in the documentation ( #71656 )
5 years ago
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
5 years ago
66e38bf499
docs: Remove examples using the `ec2.py` script ( #69107 )
...
This script is mostly unmaintained and relies on the deprecated and
unmaintained `boto` library. Featuring it prominently in the docs
leads to many new users using it instead of the supported `aws_ec2`
inventory plugin.
5 years ago
59b80b9146
docs: Update Kubernetes Guide ( #71372 )
...
Fixes : #61681
Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
5 years ago
ecea018506
Fix 404 links ( #71256 )
...
Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
5 years ago
fb9c9570d5
Fixes due to branch being renamed ( #71115 )
...
The ansible collection repository correctly renamed their default branch from `master` to `main`, which has caused a number for broken urls. This PR fixes those urls.
5 years ago
0055673c70
VMware: Inventory scenario guide for hostnames ( #71055 )
...
Added a scenario guide for ``hostnames`` parameter
for vmware_vm_inventory.
Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
5 years ago
a1ac595d42
Minor grammatical fix ( #70405 )
...
'you' -> 'your'
6 years ago
5f30f4e524
Use default network in Google Cloud Platform Guide ( #68846 )
...
* Update guide_gce.rst
The given example is not working as a SSH connection is not possible because of #59573 . Instead, in this tutorial the default network should be used which allows SSH connections in most cases.
Co-authored-by: Sandra McCann <samccann@redhat.com>
6 years ago
923655642b
mentions minimum required boto versions ( #68124 )
...
Co-authored-by: Alicia Cozine <acozine@users.noreply.github.com>
6 years ago
b437236633
Redirect inventory script links ( #69143 )
...
With inventory script migrated to their respective collection,
redirect links in documentation to their respective collection
location.
Fixes : #69139
Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
6 years ago
c7997a77d2
VMware: Document vm properties ( #68552 )
...
VMware vm inventory uses configuration properties, rather than
relying on external documents, point user to this document.
Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
6 years ago
Sandra McCann