c90922ee36
Docs - Split Developing collections page, add info on optional module_utils ( #74105 )
...
*
4 years ago
5e5bfa8116
remove deprecated ansible.module_utils._text from documentation ( #73211 )
...
According to comment in ansible.module_utils._text it is deprecated and
should not be used. This is now reflected in the documentation.
4 years ago
30c465c1a9
Promote publication ( #72400 )
...
Co-authored-by: Sandra McCann <samccann@redhat.com>
Co-authored-by: Alicia Cozine <acozine@users.noreply.github.com>
Co-authored-by: Sandra McCann <samccann@redhat.com>
4 years ago
b57444af14
Rebased pr73824 ( #73934 )
...
Co-authored-by: Eugene <k.evgen61@gmail.com>
Co-authored-by: Alicia Cozine <acozine@users.noreply.github.com>
4 years ago
8a202cae3e
Update developing_collections.rst ( #73142 )
...
Fix typo - FQCN not FCQN.
4 years ago
0a7fcd135c
Docsite: update "Migrating Ansible content to a different collection" info ( #72710 )
...
* add a reminder about ignore-*.txt entries, fix formatting, add symlink removal note
* Update docs/docsite/rst/dev_guide/developing_collections.rst
Co-authored-by: Felix Fontein <felix@fontein.de>
Co-authored-by: David Moreau Simard <moi@dmsimard.com>
Co-authored-by: Alicia Cozine <879121+acozine@users.noreply.github.com>
4 years ago
ddad9930aa
Clarify collection paths in docs ( #72510 )
...
* Clarify collection paths in docs, fix rst syntax, rephrase docs about using collection from folder/local git
Co-authored-by: Felix Fontein <felix@fontein.de>
4 years ago
2b79cd2c0f
Fix typos ( #72072 )
4 years ago
2655fc0c23
Docsite: update Migrating Ansible content to a different collection ( #71854 )
...
Co-authored-by: Felix Fontein <felix@fontein.de>
4 years ago
bbd4ec13f1
clarify that collection names use same requirements as namespaces ( #71639 )
4 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
4 years ago
addee0699e
quick update to changelog instructins ( #71492 )
4 years ago
2b7461eb52
fix broken links due to master -> main branch rename ( #71426 )
4 years ago
74f88c56a5
quick fix to change main back to devel ( #71342 )
...
* quick fix to change main back to devel
* Update docs/docsite/rst/dev_guide/developing_collections.rst
Co-authored-by: Felix Fontein <felix@fontein.de>
4 years ago
180507c62b
dev_guide: improve developing_collections.rst ( #71332 )
4 years ago
a9eb8b0488
Add some documentation for the format of meta/runtime.yml ( #71035 )
...
* Document the format of meta/runtime.yml
* Document multiple Ansible versions
Clarify difference between deprecation and tombstone fields
* add note
4 years ago
58145dff9c
document how to migrate between collections ( #70243 )
...
* document how to migrate between collections
* Apply suggestions from code review
Co-authored-by: John R Barker <john@johnrbarker.com>
Co-authored-by: Felix Fontein <felix@fontein.de>
4 years ago
92e16c2838
Few fixes for reference_appendices/faq.html ( #70719 )
...
* Format using `` instead of `, add line breaks for long lines, rephrase or remove useless text.
Move some text.
* Add clearer version of OpenSSh is affected by SCP bug
* Review some pages using ansible doc writing guide.
4 years ago
f1f782fc37
partial update of community docs to reflect collections transition ( #70488 )
4 years ago
5a28b2b86c
Add steps for how to create changelog.rst for a collection ( #70262 )
...
* Update docs/docsite/rst/dev_guide/developing_collections.rst
* add steps to create changelogs, add sentence about not using the tool
* add note for rerunning the command
Co-authored-by: Felix Fontein <felix@fontein.de>
4 years ago
d7c03e9fdb
Update testing collections to mention ansible-base versions ( #69805 )
...
Co-authored-by: Alicia Cozine <acozine@users.noreply.github.com>
4 years ago
e40889e711
Add support to install collections from git repositories ( #69154 )
...
* Enable installing collections from git repositories
* Add tests for installing individual and multiple collections from git repositories
* Test to make sure recursive dependencies with different syntax are deduplicated
* Add documentation
* add a changelog
* Skip Python 2.6
* Only fail if no collections are located in a git repository
Add support for a 'type' key for collections in requirement.yml files.
Update the changelog and document the supported keys and allowed values for the type.
Add a note that the collection(s) in the repo must contain a galaxy.yml
* Add a warning about embedding credentials in SCM URLs
* Update with review suggestions
* suppress sanity compile failure for Python 2.6
5 years ago
c884c5fddf
add pointer to namespace and collection name restrictions ( #69761 )
5 years ago
3a4e227efa
remove build errors including guess ( #69711 )
...
* remove build errors including guess
* fixed shippable errors
5 years ago
caa263e2cf
Document how to migrate a standalone role to a collection ( #68687 )
...
Adds docs for role developers/owners in the collections ecosystem
5 years ago
abb807e5dd
Extend dev guide for collection testing and collection hacking ( #68899 )
...
* Make clear which BOTMETA.yml is meant (some collections also have one), fix itemization, document /rebuild and /rebuild_failed, add section on how to test collections with ansible-test, update supported versions for compile tests, add a section on hacking collections, implement feedback.
* Update docs/docsite/rst/dev_guide/developing_collections.rst
Co-Authored-By: Felix Fontein <felix@fontein.de>
Co-authored-by: Alicia Cozine <acozine@users.noreply.github.com>
5 years ago
02e36fbfc2
fix broken link in developing collections ( #68442 )
5 years ago
4844adff9a
Collection developer guide - BOTMETA ( #67538 )
...
* Docs: Improve how to migrate and create collections
* Update docs/docsite/rst/dev_guide/developing_collections.rst
Co-Authored-By: Alicia Cozine <879121+acozine@users.noreply.github.com>
5 years ago
a60feeb3c1
Specify lowercase only for Galaxy namespaces ( #67485 )
...
* specify lowercase only for galaxy namespaces
* doh... include meta file
5 years ago
98c1fc9d3a
add a testing section to collections dev guide ( #67370 )
...
Signed-off-by: Adam Miller <admiller@redhat.com>
5 years ago
4dd2513371
add info on creating doc fragments in a collection ( #67171 )
...
* add info on creating doc fragments in a collection
Co-authored-by: Alicia Cozine <879121+acozine@users.noreply.github.com>
5 years ago
20eb1dca99
Update Galaxy docs to use "token" rather than "API key" ( #66644 )
...
We have called an API token many things. I changed the command line argument to
"--token", so now I'm unifying the documentation. I looked at both Galaxy and
Automation Hub and Galaxy is the only place that still uses the term "API Key",
which it could be argued should change.
5 years ago
0ca79a4234
Clarify how to use the Galaxy token ( #65961 )
...
* DOCS: clarify how to use the Galaxy token, with info for installs and api-key
5 years ago
a01376a493
update configuring ansible-galaxy client ( #64796 )
...
* update configuring ansible-galaxy client, deduplicate, clarify tokens, AH procedures, etc.
5 years ago
f8f7662850
Add the ability to ignore files and collection build ( #64688 )
5 years ago
6a662b0ed0
clarify acceptable file types in collection docs ( #64618 )
...
* clarify acceptable file times in collection docs
* implement feedback
5 years ago
797397558e
Add note about large tarball sizes for collections ( #64411 )
...
* add note on collection tarball size
5 years ago
6a2902c8d5
clarify no subfolders and md only for collections /docs folder ( #63808 )
5 years ago
911aa6aab9
Default collection install path to first path in COLLECTIONS_PATHS ( #62870 )
5 years ago
d41050b28b
Add some documentation about plugins in collections ( #62465 )
...
* Add some documentation about using plugins in collections
- FQCN requirements
- Sharing code in collections
- Limitations with inventory caching
5 years ago
7e01de96d7
add more anchors to collections docs ( #62827 )
5 years ago
1b3bf33bdf
add anchors to support galaxy links ( #62808 )
5 years ago
679d3a46fa
doc: fix typo ( #62668 )
5 years ago
2969614c2c
Fix link syntax and a typo in dev collections doc ( #62650 )
5 years ago
7badeb6df0
[docs] split collections into user and dev guide sections ( #62363 )
...
* split collections into user and dev guide sections
* sentence case
5 years ago
Alicia Cozine