Commit Graph

143 Commits (058a69e6b037c87229d1d28742458e90fc1522cd)

Author SHA1 Message Date
Sean Cavanaugh 817e1045bb
Update network_resources.rst (#76040)
* Update network_resources.rst

I am not sure a fully qualified URL should be here... but teach me great documentation gods

* Change platform index external link to internal ref

Co-authored-by: Aine Riordan <44700011+ariordan-redhat@users.noreply.github.com>
3 years ago
Paul Capron afbef70bad
documenting_modules_network.rst: Add missing space (#75972) 3 years ago
Samuel Gaist 4d398ca3a4
docs - Use code-block to format examples in Network Guide (#75850)
Fixes #75676
3 years ago
Erik Zettel 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
3 years ago
Suhas Bharadwaj 747789787b
added a caveat to say check individual module documentation for compatibility (#75582) 3 years ago
Abhijeet Kasurde 1dc495405f
Added missing colon in note (#75465)
Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
3 years ago
Alicia Cozine 3c3e30a610
Docs: Add Matrix as a chat option (#75406) 3 years ago
Ikko Ashimine 1b95b1e7a4
Fix typo in developing_plugins_network.rst (#75382)
extention -> extension
3 years ago
Alicia Cozine 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>
3 years ago
Ashwini Mhatre d016499dcd
Update network user guide to point to ansible.utils.cli_parse module and add docs for validate plugin (#75104)
* Update network user guide to point to ansible.utils.cli_parse module as ansible.netcommon.cli_parse is deprecated from ansible.netcommon 2.0.0 release
3 years ago
Akira Yokochi 9af0d91676
fix option name for parsed (#75229) 3 years ago
Sandra McCann ea0ba7bf30
update terminology based on recent IBM Style Guide word list (#75089) 3 years ago
Toshio Kuratomi 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>
4 years ago
Sean Cavanaugh 20ef733ee0
Update network_resources.rst (#74810) 4 years ago
Kelly Brazil 91212b2008
Add JC filter plugin example (#74563)
Co-authored-by: Abhijeet Kasurde <akasurde@redhat.com>
4 years ago
Joseph Jacobs dcb807dea7
Update cli_parsing.rst (#74555)
Bad indent in an example
4 years ago
Ernst Oudhof 7ca5dede97
Add weos4 network platform to documentation (#74088)
* Add weos4 network platform to documentation

* Fix small format issues
4 years ago
David Shrewsbury d44eb03f49
Remove include from tests (#74330) 4 years ago
Willams de Lima fa05af8321
Fixing ad-hoc commands #73636 (#73646) 4 years ago
Akira Yokochi fce22529c4
fix typo (#73434) 4 years ago
Nilashish Chakraborty 45240c1871
Update NX-OS platform guide with MDS information (#73315)
Signed-off-by: NilashishC <nilashishchakraborty8@gmail.com>
4 years ago
Felix Fontein 73aa571305
Make sure to mention collection version for version_added as well. (#73270) 4 years ago
Sean Blundy a5eb788578
Minor Edit: Fix typo in platform_index.rst (#72564)
Fix Dell OS 10 dellemc.os10.0s10 to dellemc.os10.os10 in platform_index.rst
4 years ago
Sandra McCann 0e5911d650
add cli parser documentation (#71497)
* with native network example, linux example
4 years ago
Shufeng 4bf61f0714
Fix typo in delveloping_plugins_network (#71737) 4 years ago
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
4 years ago
Sandra McCann b6f10b9b52
update Network Advanced Topics for FQCN (#71325)
* update Network Advanced Topics for FQCN
4 years ago
Abhijeet Kasurde a1257d75aa
network: Correct documentation (#71246)
ini-style inventory does not support Ansible Vault password.
This fixes network_best_practices_2.5 doc.
Fixes: #69039

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
4 years ago
Sandra McCann f79a7c5585
Update Network Getting Started for FQCN/collection world (#71188)
* pull out network roles, cleanup, update first playbook examples, update gather facts section, some inventory conversion to .yml, update inventory and roles, simplify the navigation titles, fix tocs, feedback comments
4 years ago
Sandra McCann 172230d7b8
update Ansible-maintained platform guides with FQCN (#70369)
* update platform guides with FQCN
* implemented feedback
* fix remainin fqcn
* Update docs/docsite/rst/network/user_guide/platform_netconf_enabled.rst
Co-authored-by: Alicia Cozine <879121+acozine@users.noreply.github.com>
4 years ago
Sandra McCann f4388de14d
add another resource module example (#71162)
* Update docs/docsite/rst/network/user_guide/network_resource_modules.rst
Co-authored-by: Nilashish Chakraborty <nilashishchakraborty8@gmail.com>
4 years ago
Jeff Groom 79f7104556
Update platform_index.rst (#70927) 4 years ago
Nathaniel Case a0523e5b8a
Update documentation of httpapi's handle_httperror method for clarity (#70991) 4 years ago
Sandra McCann 54bee7152b
Update network platform guides with FQCN (#70699)
* fqcn all the docs things!
4 years ago
PJ Waskiewicz 69e5c6c14a
Update network_best_practices_2.5.rst (#70962)
Fix a small typo in the playbook tasks sample section
4 years ago
Toshio Kuratomi 9dda393d70
Collections docs generation (#59761)
* Build documentation for Ansible-2.10 (formerly known as ACD).

Builds plugin docs from collections whose source is on galaxy

The new command downloads collections from galaxy, then finds the
plugins inside of them to get the documentation for those plugins.

* Update the python syntax checks
  * docs builds can now require python 3.6+.

* Move plugin formatter code out to an external tool, antsibull-docs.
  Collection owners want to be able to extract docs for their own
  websites as well.
* The jinja2 filters, tests, and other support code have moved to antsibull
* Remove document_plugins as that has now been integrated into antsibull-docs

* Cleanup and bugfix to other build script code:
  * The Commands class needed to have its metaclass set for abstractmethod
    to work correctly
  * Fix lint issues in some command plugins

* Add the docs/docsite/rst/collections to .gitignore as
  everything in that directory will be generated so we don't want any of
  it saved in the git repository
* gitignore the build dir and remove edit docs link on module pages

* Add docs/rst/collections as a directory to remove on make clean
* Split the collections docs from the main docs

* remove version and edit on github
* remove version banner for just collections
* clarify examples need collection keyword defined

* Remove references to plugin documentation locations that no longer exist.
  * Perhaps the pages in plugins/*.rst should be deprecated
    altogether and their content moved?
  * If not, perhaps we want to rephrase and link into the collection
    documentation?
  * Or perhaps we want to link to the plugins which are present in
    collections/ansible/builtin?

* Remove PYTHONPATH from the build-ansible calls
  One of the design goals of the build-ansible.py script was for it to
  automatically set its library path to include the checkout of ansible
  and the library of code to implement itself.  Because it automatically
  includes the checkout of ansible, we don't need to set PYTHONPATH in
  the Makefile any longer.

* Create a command to only build ansible-base plugin docs
  * When building docs for devel, only build the ansible-base docs for
    now.  This is because antsibull needs support for building a "devel
    tree" of docs.  This can be changed once that is implemented
  * When building docs for the sanity tests, only build the ansible-base
    plugin docs for now.  Those are the docs which are in this repo so
    that seems appropriate for now.
4 years ago
Alicia Cozine db354c0300
Docs: User guide overhaul, part 5 (#70307) 4 years ago
Sandra McCann aa59c23aed
update platform table with links to collections (#70373) 4 years ago
Sandra McCann 647c6cd289
updates to ansible-maintained collections guidelines (#70178) 4 years ago
Sandra McCann 2609482975
How to contribute to Ansible maintained collections (#69202)
contributor info with HTML table
4 years ago
Nilashish Chakraborty 5a7f2f9d5d
Add platform guide for FRR (#69773)
* Add platform guide for FRR

Signed-off-by: NilashishC <nilashishchakraborty8@gmail.com>

* Add entry in index

Signed-off-by: NilashishC <nilashishchakraborty8@gmail.com>
5 years ago
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>
5 years ago
Sandra McCann 3a4e227efa
remove build errors including guess (#69711)
* remove build errors including guess

* fixed shippable errors
5 years ago
Akira Yokochi 887263c315
fix indents of EOS Platform Options (#67564) 5 years ago
Sandra McCann 7ef7c1b5d7
add note on write access to socket_path (#67060)
* Change socket_path error messages to not directly refer to socket_path
* Apply suggestions from code review

Co-Authored-By: Nathaniel Case <this.is@nathanielca.se>
5 years ago
Sandra McCann 68ab8c23be Network prompts (#66584)
* add network prompt examples and module examples

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

Co-Authored-By: Nathaniel Case <this.is@nathanielca.se>
5 years ago
Sandra McCann 9922014441 add details on network gather facts improvements (#66220)
* add details on network gather facts improvements, implement feedback
5 years ago
Sandra McCann 2ad6055efd Document network resource modules (#66226)
* add network resource module details to docs

(cherry picked from commit 3e35d2d63ce17fb694e645785ad855f01420f7d8)

* network resource module page, with example output
5 years ago
Sandra McCann 136b3be722 added unit test details for resource modules (#65891)
* added unit test details for resource modules
5 years ago
Alicia Cozine 860cacc54f Docs: User guide overhaul, part 2 (#65474) 5 years ago