Commit graph

124 commits

Author SHA1 Message Date
Akira Yokochi
fce22529c4
fix typo (#73434) 2021-02-03 09:17:02 -06:00
Nilashish Chakraborty
45240c1871
Update NX-OS platform guide with MDS information (#73315)
Signed-off-by: NilashishC <nilashishchakraborty8@gmail.com>
2021-01-21 12:03:50 -05:00
Felix Fontein
73aa571305
Make sure to mention collection version for version_added as well. (#73270) 2021-01-18 14:53:10 -05:00
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
2020-11-10 16:22:07 -06:00
Sandra McCann
0e5911d650
add cli parser documentation (#71497)
* with native network example, linux example
2020-09-22 11:54:24 -05:00
Shufeng
4bf61f0714
Fix typo in delveloping_plugins_network (#71737) 2020-09-15 16:03:08 -04: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
Sandra McCann
b6f10b9b52
update Network Advanced Topics for FQCN (#71325)
* update Network Advanced Topics for FQCN
2020-08-26 12:33:59 -05:00
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>
2020-08-18 15:34:25 -05:00
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
2020-08-18 14:14:32 -05:00
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>
2020-08-10 15:09:35 -05:00
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>
2020-08-10 11:18:43 -05:00
Jeff Groom
79f7104556
Update platform_index.rst (#70927) 2020-08-04 14:31:37 -04:00
Nathaniel Case
a0523e5b8a
Update documentation of httpapi's handle_httperror method for clarity (#70991) 2020-08-03 16:35:00 -04:00
Sandra McCann
54bee7152b
Update network platform guides with FQCN (#70699)
* fqcn all the docs things!
2020-07-31 15:57:57 -05:00
PJ Waskiewicz
69e5c6c14a
Update network_best_practices_2.5.rst (#70962)
Fix a small typo in the playbook tasks sample section
2020-07-29 11:41:18 +05:30
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.
2020-07-17 13:07:35 -07:00
Alicia Cozine
db354c0300
Docs: User guide overhaul, part 5 (#70307) 2020-07-14 17:00:44 -04:00
Sandra McCann
aa59c23aed
update platform table with links to collections (#70373) 2020-07-02 10:20:11 -05:00
Sandra McCann
647c6cd289
updates to ansible-maintained collections guidelines (#70178) 2020-06-19 14:04:19 -05:00
Sandra McCann
2609482975
How to contribute to Ansible maintained collections (#69202)
contributor info with HTML table
2020-06-15 15:38:42 -05:00
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>
2020-06-09 10:22:30 +05:30
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
Sandra McCann
3a4e227efa
remove build errors including guess (#69711)
* remove build errors including guess

* fixed shippable errors
2020-05-29 11:56:49 -05:00
Akira Yokochi
887263c315
fix indents of EOS Platform Options (#67564) 2020-02-19 13:26:49 -05:00
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>
2020-02-11 09:49:20 -06:00
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>
2020-01-23 18:02:16 -06:00
Sandra McCann
9922014441 add details on network gather facts improvements (#66220)
* add details on network gather facts improvements, implement feedback
2020-01-10 15:06:49 -06:00
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
2020-01-10 14:12:26 -06:00
Sandra McCann
136b3be722 added unit test details for resource modules (#65891)
* added unit test details for resource modules
2020-01-10 13:49:42 -06:00
Alicia Cozine
860cacc54f Docs: User guide overhaul, part 2 (#65474) 2019-12-12 13:35:17 -05:00
anshulbehl
b349ec8fcf Adding network plugin changes for netconf and network_cli (#65708)
* Adding network plugin changes for netconf and network_cli
2019-12-11 18:42:01 -06:00
Sandra McCann
41472ee387 Describe different ways to set connection timeout options (#65126)
* add timeout option examples, link to new section, implement feedback
2019-12-02 10:42:45 -06:00
Sandra McCann
7084dd727a clarify httpapi with an example (#65083) 2019-11-25 16:30:16 -06:00
Sandra McCann
b2fc12a29f clean up network toc (#65264) 2019-11-25 15:17:49 -06:00
Egor Zaitsev
f3575c5025 docs: add solution to timeout errors to docs (#65140) 2019-11-21 15:05:07 -05:00
Xu Yuandong
09aebf33e4 Add doc to ce for user guide. (#63982) 2019-11-19 09:45:07 -05:00
brasswood
090dca7569 Note for virtual environment users (#64040) 2019-10-31 11:47:09 -04:00
Alicia Cozine
941a9b68fc Docs: User guide overhaul, part 1 (#63056) 2019-10-08 13:46:38 -04:00
Andreas Olsson
c8315bfd60 Prefer https:// links in the docs site (#62939)
This is a follow-up of last year's 1a11cec. It deals with links which
at that point either were not present or did not support https://.
2019-09-30 15:11:19 -04:00
Michael Prokop
b33ae14949 doc: fix typos (#62852) 2019-09-26 10:18:29 -04:00
Sandra McCann
b17581a307
[Docs] Document the resource module builder (#62222) 2019-09-23 11:10:05 -04:00
Akira Yokochi
6952295114 explicited RouterOS does not support connection: local (#62203) 2019-09-12 13:45:28 -04:00
Kevin Breit
54906a68fe Docs - Add Meraki to platform option list (#61651) 2019-09-03 11:04:39 -04:00
Ganesh Nalawade
d3d9c5c273 Fix doc for network_cli connection retry timer (#61509) 2019-08-29 10:24:43 -04:00
Ganesh Nalawade
768dbe5490
Add support for network_cli connection retry (#61103)
* Add support for network_cli connection retry

*  Add network_cli connection configuration option
   to allow retrying the connection initialization
   with remote host.

* Add docs

* Fix test failures

* Fix review comments
2019-08-28 09:46:42 +05:30
Rohit
11ba2a965d
platform guide updates (#61121)
* platform guide updates

Signed-off-by: rohitthakur2590 <rohitthakur2590@outlook.com>

* sanity fix

Signed-off-by: rohitthakur2590 <rohitthakur2590@outlook.com>
2019-08-23 20:23:50 +05:30
Nilashish Chakraborty
d06930d6f6 Add iosxr platform guide (#60936)
Signed-off-by: NilashishC <nilashishchakraborty8@gmail.com>
2019-08-22 14:05:15 -04:00
Toshio Kuratomi
c1547f10d6 Fix table headers and width (#60549) 2019-08-21 16:55:16 -04:00
Ganesh Nalawade
49736b6b27
Add support to configure network_cli terminal related options (#60086)
* Add support for configurable terminal plugin options

Fixes #59404

*  Add terminal options to support platform specific login menu
*  Add terminal options to support configurable options for stdout
   and stderr regex list

* Fix CI failures

* Fix CI issues

* Fix review comments and add integration test

* Fix sanity test failures

* Fix review comments

* Fix integration test case

* Fix integration test failure

* Add support to configure terminal related options

Fixes https://github.com/ansible/ansible/issues/59404

*  Add network_cli configurable options to support platform specific login menu
*  Add network_cli configurable options to support configurable options for stdout
   and stderr regex list

* Fix review comment

* Fix review comment
2019-08-19 18:56:20 +05:30