Commit Graph

1918 Commits (5ac2c6d4fe97ec3e2c25ce53bc6daaead0d8f3b4)

Author SHA1 Message Date
Toshio Kuratomi 019d078a5a
Move common build code from _build_helpers (#55986)
We have some common code used by several docs scripts.  Migrate that
into the build-only shared code repository.

* Move lib/ansible/utils/_build_helpers.py to the directory for common
  build code
* Migrate docs/bin/dump_config.py to a build-ansible subcommand
* Migrate dump_keywords to the build-ansible framework
  * Make the script more maintainable by using functions and good
    variable names
  * Port to Python3 idioms
  * Fix bug so that private attributes will be undocumented
* Move generate_man to a build-ansible subcommand
* Port plugin_formatter to a build-ansible subcommand
* Rework command_plugins so that docs scripts can target Python-3.4+ and
  releng-only subcommands can use more recent versions of Python.
  The architecture is now that command_plugins/* need to be importable
  on Python-3.4.  The init_parsers() method needs to run on Python-3.4.
  But the main() method can utilize features of more recent Python as
  long as it fits within those parameters.
* Update docs build requirements

Port the plugin_formatter to build-ansible framework
5 years ago
Rémy Léone 30206d3066 Add an example for the debugging module (#50197)
+label: docsite_pr
5 years ago
d-little 11d61cc01e Swap ordering to ensure Dynamic always first (#58998) 5 years ago
Alicia Cozine 0dd3fb82eb get rid of Sphinx 2.1.2 errors (#59001) 5 years ago
Martin Krizek aea5b795c0 Make ansible_index_var accessible as a magic var (#59030) 5 years ago
Toshio Kuratomi 33d2728879 Rename python files in hacking/ directory to have .py suffix
ansible-test only passes files which have the .py suffix for sanity
tests on python files.  This change will allow sanity tests to run on
the Python files in hacking/

* Rename test-module to test-module.py
* Symlink test-module for backwards compat since end users may be using
  test-module
* Fix test-module sanity errors that are now triggered
* Rename ansible_profile to ansible-profile.py
* Rename build-ansible
5 years ago
Toshio Kuratomi 146a7f8ff6 Split the metaclass == type and from future boilerplate code.
The metaclass boilerplate is safe to apply en masse.  The future import
boilerplate needs code to be inspected to be sure that there aren't any
py2isms that need to be fixed.  Split these two checks so that we can
fix them independently

Be explicit about which files are grandfathered so we can fix them up one by one
5 years ago
Gonéri Le Bouder 13de8686e5 vmware: vmware_guidelines.rst
VMware specific documentation that explains:

- how to run the functional tests
- and the conventions.
- clarify the difference between govcsim and vcsim

Co-Authored-By: Alicia Cozine <879121+acozine@users.noreply.github.com>
Co-Authored-By: Abhijeet Kasurde <akasurde@redhat.com>
5 years ago
Samy Coenen 0befccbeb9 Update intro_inventory.rst (#58732) 5 years ago
Jordan Borean b6791e6ae3
ansible-galaxy: add collection sub command (#57106)
* ansible-galaxy: add collection init sub command

* Fix changelog and other sanity issues

* Slim down skeleton structure, fix encoding issue on template

* Fix doc generation code to include sub commands

* Added build step

* Tidy up the build action

* Fixed up doc changes and slight testing tweaks

* Re-organise tests to use pytest

* Added publish step and fixed up issues after working with Galaxy

* Unit test improvments

* Fix unit test on 3.5

* Add remaining build tests

* Test fixes, make the integration tests clearer to debug on failures

* Removed unicode name tests until I've got further clarification

* Added publish unit tests

* Change expected length value

* Added collection install steps, tests forthcoming

* Added unit tests for collection install entrypoint

* Added some more tests for collection install

* follow proper encoding rules and added more tests

* Add remaining tests

* tidied up tests and code based on review

* exclude pre-release versions from galaxy API
5 years ago
Sandra McCann e5a1d85092 clarify FQCN needs for plugins (#58870)
* clarify FQCN requirement, fix example
5 years ago
Brian Coca c2469648e4 Docs on general precedence (#50201)
* Add docs/docsite/rst/reference_appendices/general_precedence.rst

Co-Authored-By: Sandra McCann <samccann@redhat.com>
5 years ago
Wojciech Sciesinski f9a31e3e17 Provide the list of packages in a modern way (#58668) 5 years ago
Sandra McCann 3bfe32b9d9 fixed formatting and spelling issues (#58686) 5 years ago
Sviatoslav Sydorenko ce79c8eb27 Fix typos in the Collections Tech Preview doc page (#58669) 5 years ago
Marek Anderson 3a919d4bec Doc - editorial for correct acronym introduction (#58519)
Introduce acronym GCP on first use. Introduce GCE acronym at all.
5 years ago
Felix Fontein f0801879c7 Rename xenserver_guest_facts -> xenserver_guest_info (#57032)
* Rename xenserver_guest_facts -> xenserver_guest_info.

* Add changelog.

* Forgot one test.
5 years ago
Gonéri Le Bouder 2401154fc4 VMware: rename VMWare to VMware (#58535)
Follow the nomenclature convention decided in https://github.com/ansible/ansible/pull/56814
5 years ago
Sandra McCann 35b6345bdc Add a banner message to warn when not on latest documentation (#58526)
* add banner to versions that are not latest

* move div into script

* fix div

* move comment

* fix shippable errors
6 years ago
Nabeel Al-Saber 7afdf11456 Add Oracle scenario guide (#58443)
* Create and update docs/docsite/rst/scenario_guides/guide_oracle.rst
6 years ago
Sloane Hertel ec1287ca7e
Fix notifying handlers by using an exact match (#55624)
* Fix notifying handlers by using an exact match rather than a string subset if listen is text rather than a list

* Enforce better type checking for listeners

* Share code for validating handler listeners

* Add test for handlers without names

* Add test for templating in handlers

* Add test for include_role

* Add a couple notes about 'listen' for handlers

* changelog

* Add a test for handlers without names

* Test templating in handlers

* changelog

* Add some tests for include_role

* Add a couple notes about 'listen' for handlers

* make more sense

* move local function into a class method
6 years ago
Klaus Frank ee52b60d7d Add note about delegate_facts to run_once (#58241)
* Add note about delegate_facts to run_once
6 years ago
Alicia Cozine 44b6f2ff56 removes last :doc: links in other sections of the docs (#58432)
* removes last :doc: links in other sections of the docs

* fix references to playbooks intro page
6 years ago
Alicia Cozine d4f0bc183e removes last :doc: links in user guide (#58433)
* removes last :doc: links in user guide
6 years ago
Alicia Cozine 3fc0694ffc removes last :doc: links in the dev guide (#58417) 6 years ago
Sandra McCann 5569135efd create scenario guide template file (#58212)
* create scenario guide template file

* Apply suggestions from code review

Co-Authored-By: Alicia Cozine <879121+acozine@users.noreply.github.com>
6 years ago
ndclt 4376e88849 Coherence between example and text (use of to_native) (#58279) 6 years ago
Sayed Anisul Hoque 57596edcca Updated the playbooks_tags guide (#58011)
* Updated the playbooks_tags guide
6 years ago
markafarrell 43872d6b88 Fix netconf guess_network_os to use ssh_config if supplied. (#55199)
* feature: use network_os=auto to trigger network os guessing

* doc: add debug messages

* fix linting

* fix test_netconf_init default network_os is auto

* add documentation

* fix rst errors

* use init lexer

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

Co-Authored-By: Sandra McCann <samccann@redhat.com>

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

Co-Authored-By: Sandra McCann <samccann@redhat.com>

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

Co-Authored-By: Sandra McCann <samccann@redhat.com>

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

Co-Authored-By: Sandra McCann <samccann@redhat.com>

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

Co-Authored-By: Sandra McCann <samccann@redhat.com>

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

Co-Authored-By: Sandra McCann <samccann@redhat.com>

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

Co-Authored-By: Sandra McCann <samccann@redhat.com>

* Update lib/ansible/plugins/connection/netconf.py

Co-Authored-By: Sandra McCann <samccann@redhat.com>

* Update lib/ansible/plugins/connection/netconf.py

Co-Authored-By: Sandra McCann <samccann@redhat.com>

* Update lib/ansible/plugins/connection/netconf.py

Co-Authored-By: Sandra McCann <samccann@redhat.com>

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

Co-Authored-By: Sandra McCann <samccann@redhat.com>

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

Co-Authored-By: Sandra McCann <samccann@redhat.com>

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

Co-Authored-By: Sandra McCann <samccann@redhat.com>
6 years ago
Sandra McCann f3720c90e0 [WIP] Add dropdown version selection to docsite (#55655)
* docs: Add way to select version for documentation
6 years ago
Lucian Maly 446027341a Update playbooks_strategies.rst (#57784)
* Update playbooks_strategies.rst

##### SUMMARY
This page is very confusing and may suggest, that there is still a `serial` strategy (like it used to), but now it is just a directive of `linear` strategy. Multiple people reported this to me and it needs change.


##### ISSUE TYPE
- Docs Pull Request

+label: docsite_pr

* Update docs/docsite/rst/user_guide/playbooks_strategies.rst

Co-Authored-By: Sam Doran <sdoran@redhat.com>

* Update docs/docsite/rst/user_guide/playbooks_strategies.rst

Co-Authored-By: Sam Doran <sdoran@redhat.com>

* Updates strategies page more broadly

* incorporate samdoran feedback

* fixes broken link

* new page title, focus on user intent

* more sdoran feedback

* adds details on setting the number of forks
6 years ago
Sandra McCann 7765bd41e6 add platform docs to network dev guide (#57960)
* add info on how to create platform docs to network dev guide
6 years ago
Alicia Cozine 158f97bfb2 updates docs reqs to specify Pygments version, remove tornado (#58007) 6 years ago
Sayed Anisul Hoque b768a0780c Update playbooks_vault.rst (#58005)
Corrected the internal reference link to point to the FAQ entry.

+label: docsite_pr
6 years ago
Felix Fontein 505c99265c docsite: remove lexers which have been fixed in Pygments 2.4.0 (#57508)
* Remove lexers which have been fixed in Pygments 2.4.0.
* Add Pygments >= 2.4.0 to test runner.
* Fix pages that triggered lexer errors.

Co-Authored-By: Sviatoslav Sydorenko <wk.cvs.github@sydorenko.org.ua>
6 years ago
Felix Fontein fe8a3108a8 Fix error when a deprecated alias of a deprecated module is processed. (#57774) 6 years ago
Sayed Anisul Hoque 2bdc4e5b4a Documentation error in the Test if a list contains a value section (#57923)
* Update docs/docsite/rst/user_guide/playbooks_tests.rst - 'contains' test works with 'select/reject' and 'selectattr/rejectattr' but not 'map'
6 years ago
Alicia Cozine 8dfa376e1c removes link from 404 content, explains options (#57971) 6 years ago
Ken Celenza 1a63f8642e Update local module options (#57553)
* Docs: Point out that local plugins can be loaded based on ansible.cfg settings
6 years ago
Alicia Cozine e834cd7d41 updates reqs for building docs locally (#57967) 6 years ago
Alicia Cozine 5658b2ee3e
Adds custom 404 with cowsay image (#57422)
* Adds custom 404 with image, updates CI reqs, sets version latest for TOC links on 404 page
6 years ago
asouini a096fa5c12 filter bare variable with |bool (deprecation warn) (#57691)
* filter bare variable with |bool (deprecation warn)

https://github.com/ansible/ansible/pull/57691#issuecomment-502134480
6 years ago
Brian Coca 49983fdaf7 doc draft for collections (#57853)
* doc draft for collections

* fixes

* Update docs/docsite/rst/collections_tech_preview.rst

Co-Authored-By: Sandra McCann <samccann@redhat.com>

* Update docs/docsite/rst/collections_tech_preview.rst

Co-Authored-By: Sandra McCann <samccann@redhat.com>

* Apply suggestions from doc review

* Update docs/docsite/rst/collections_tech_preview.rst

* Update docs/docsite/rst/collections_tech_preview.rst
6 years ago
Pierre-Louis Bonicoli c289006e05 validate-modules: new module: fail if 'type' isn't documented
Don't require 'type' when:
- parameter name starts with an underscore
6 years ago
Sayed Anisul Hoque 78f87f2451 Updated "Speeding up Vault Operations" section (#57701)
* Updated "Speeding up Vault Operations" section


Co-Authored-By: Alicia Cozine <879121+acozine@users.noreply.github.com>
6 years ago
Sayed Anisul Hoque b9c893ec6f Updated the section under "Aborting the play" in the Error Handling In Playbooks page (#57705)
* Updated the section under "Aborting the play"

Updated "Aborting the play" section in the Error Handling In Playbooks page. Removed the reference to marking all hosts as failed.

+label: docsite_pr

* Update docs/docsite/rst/user_guide/playbooks_error_handling.rst

Co-Authored-By: Sandra McCann <samccann@redhat.com>
6 years ago
Sandra McCann 5243cba0b2 describe how to link to modules or plugins (#57806) 6 years ago
ggeorgg 3efb57f64e Typo (#57795) 6 years ago
Arnaud RENARD 1a5fd720a4 Ansible galaxy role download should not have to perform aditionnal check against tar archive file extension #56616. (#56617)
Ansible galaxy role download checked for `.tar.gz`, but `tarfile.is_tarfile(...)` can identify and open any valid tarfile. This change uses transparent stream compression to make `.tar.gz` and `.tar.bz2` formats valid with python 2.6.x/2.7.x (as well as `.tar.xz` with python 3.x).
6 years ago
Strahinja Kustudic 6131de29d4 Improve regex_replace filter docs (#57450)
* Add a few examples of how to correctly use `regex_replace` filter
because it behaves differently on different Python versions when using
regex qualifiers that can match an empty string (e.g. '*', '?', etc).
6 years ago