You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
ansible/docs/docsite
Sloane Hertel 97f011cf94
Add verify subcommand to 'ansible-galaxy collection' (#65618)
* [WIP] Add verify subcommand command to 'ansible-galaxy collection'

* Fix pep8 and use consistent display order

* WIP - docs

* Remove some redundancy in verify display messages by using an error queue for each collection

* Share common code and improve output format

* clean up documentation

* typo

* Apply suggestions from code review

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

* Move ModifiedContent namedtuple to the global scope

Add a public metadata property

Rename function to _get_json_from_tar_file

* Add some unit tests

* fix using common functions after rebase

* changelog

* Improve efficiency finding specific installed collections

Improve efficiency by only downloading the tar.gz from the galaxy server for comparison after checking that the collection has been installed

Handle multiple collection paths

Fix up tests

* pep8

* reword that for accuracy

* use more common code and verify collection name

* Improve error message and add documentation

* Update unit tests and add coverage for both local and remote collections that are unable to be located

* Only validate collections using the format collection_namespace.collection_name

Fix tests to reflect that

Fix documentation

* Fix a bug when a local collection does not contain a file

* pep8

* Fix formatting

Co-authored-by: Sandra McCann <samccann@redhat.com>
5 years ago
..
_extensions docsite: remove lexers which have been fixed in Pygments 2.4.0 (#57508) 6 years ago
_static Docs: improve anchors vs. header bar (#67244) 5 years ago
_themes/sphinx_rtd_theme docs: Fixed "Edit on GitHub" link for plugin, cli (#66745) 5 years ago
js/ansible consolidated docs 8 years ago
rst Add verify subcommand to 'ansible-galaxy collection' (#65618) 5 years ago
.gitignore Initial ansible-test sanity docs. (#26775) 7 years ago
.nojekyll consolidated docs 8 years ago
Makefile Fix netconf plugin related to collections (#65718) 5 years ago
Makefile.sphinx Adds the ability to override the doc build output directory from the command line. (#36604) 7 years ago
README.md reduce docs/docsite/README to essential info (#64287) 5 years ago
jinja2.inv Upstream jinja has decided not to rename from jinja2. (#66880) 5 years ago
keyword_desc.yml Improve ignore_unreachable documentation (#64938) 5 years ago
modules.js consolidated docs 8 years ago
python2.inv Add a script to update the intersphinx inventory (#66646) 5 years ago
python3.inv Add a script to update the intersphinx inventory (#66646) 5 years ago
requirements.txt Move common build code from _build_helpers (#55986) 5 years ago
variables.dot consolidated docs 8 years ago

README.md

Ansible documentation

This project hosts the source behind docs.ansible.com.

To create clear, concise, and consistent contributions to Ansible documentation, please refer to the following information.

Contributions

Contributions to the documentation are welcome.

The Ansible community produces guidance on contributions, building documentation, and submitting pull requests, which you can find in Contributing to the Ansible Documentation.

You can also join the Docs Working Group.

Ansible style guide

Ansible documentation is written in ReStructuredText(RST). The Ansible style guide provides linguistic direction and technical guidelines for working with reStructuredText, in addition to other resources.

Tools

The Ansible community uses a range of tools and programs for working with Ansible documentation. Learn more about Other Tools and Programs in the Ansible Community Guide.

GitHub

Ansible documentation is hosted on the Ansible GitHub project. For GitHub workflows and other information, see the GitHub Guides.