[ansible-devel] Collection module documentation available now on docs.ansible.com for review
*Collection module documentation available now on docs.ansible.com for review* After significant months of effort, we have now restored the module-level documentation on docs.ansible.com! This effort required coordination between the Ansible docs team and the community team and developers to pull the module documentation from the collections on Galaxy and publish them on our docsite again. While there's more work to do, we'd like all collection maintainers to take a look at your respective collections and let us know where you see problems: 1. Go to https://docs.ansible.com/ansible/2.10/collections/index.html 2. Verify your collection module and plugin documentation looks valid. 3. See https://github.com/ansible-community/antsibull/issues for a list of known issues and enhancements we are already tracking. Before you open an issue, please drop into the #ansible-docs IRC channel to discuss/troubleshoot any problems you are seeing. *Known issues and Important Caveats* - The documentation reflect the version of each collection that is in the current Ansible 2.10 Alpha. We will update after each alpha release to pick up whatever collection version is in that release. - On 2.10 official release, the documentation will stay fixed at the collection version in that release. We will not be able to update until the next Ansible release (2.10.1 for example). - Boolean default is showing 0. This is fixed and will be updated in the docs soon. - community.general module docs are not present yet. This should be fixed soon as well. -- You received this message because you are subscribed to the Google Groups "Ansible Development" group. To unsubscribe from this group and stop receiving emails from it, send an email to ansible-devel+unsubscr...@googlegroups.com. To view this discussion on the web visit https://groups.google.com/d/msgid/ansible-devel/543a0ef6-53cf-47b0-8a6c-7d6c067267e7n%40googlegroups.com.
[ansible-devel] Looking for help testing Ansible Documentation redirects
Hi everyone! I'm one of the Ansible documentation writers and we're looking for some help testing the updated docsite for collections. With Ansible 2.10, all the module documentation pages are moving to new URLs based on the collections those modules live in now. To make this transition smoother for users, we've implemented a number of redirects on the docsite so that you can smoothly go from the module in 2.9 to the module docs in 2.10. We need as many people as possible to go test out that this works without giving any 404 errors. *Steps to test:* 1. Go to http://docs.testing.ansible.com/ansible/2.10/collections/index.html, click on a collection, then click on a module or plugin. You'll see the new collection-based module documentation. 2. Edit the resulting URL to replace 2.10 with 2.9. You should see the documentation for 2.9 for that same module or plugin. 3. Edit that URL again to replace 2.9 with 2.10. You should come back to the page you started with. The only time you should get a 404 error is if the module is new in 2.10, or if an older module was removed from 2.10. Report any other 404s you find on #ansible-docs IRC if you hang out there, or email them to d...@ansible.com *Note* - that URL is only to the documentation test site which is subject to change. We'll keep it constant for a few days to gather any feedback you all have. The version-switcher on the top left isn't accurate so please just edit the url directly to go back and forth between 2.9 and 2.10. And thanks for your help! -- You received this message because you are subscribed to the Google Groups "Ansible Development" group. To unsubscribe from this group and stop receiving emails from it, send an email to ansible-devel+unsubscr...@googlegroups.com. To view this discussion on the web visit https://groups.google.com/d/msgid/ansible-devel/15a40201-da11-4039-a215-58c41c178f65n%40googlegroups.com.
[ansible-devel] Ansible package proposal to remove .rst files from tarballs
Hi folks - Currently, the Ansible package tarballs and the individual collection tarballs include .RST files. This adds to the overall size of these packages, so we are considering removing them, and instead, creating a separate `ansible-documentation` tarball that includes the .RST files and possibly the generated HTML (so users can have an offline version of the documentation that matches their Ansible tarball version). Please see https://github.com/ansible-collections/overview/discussions/120 for details and add your feedback! -- You received this message because you are subscribed to the Google Groups "Ansible Development" group. To unsubscribe from this group and stop receiving emails from it, send an email to ansible-devel+unsubscr...@googlegroups.com. To view this discussion on the web visit https://groups.google.com/d/msgid/ansible-devel/9a8d67a3-4f8b-494a-927f-8cd2efbb05c2n%40googlegroups.com.
[ansible-devel] Release Announcement: Ansible community package 8.2.0
Hello everyone, We're happy to announce the release of the Ansible 8.2.0 package! Ansible 8.2.0 includes latest version of ansible-core 2.15.2 and includes a curated set of Ansible collections that provides a vast number of modules and plugins. How to get it - This release is available on PyPI and can be installed with pip: `$ python3 -m pip install ansible==8.2.0 --user` The sources for this release can be found here: Release tarball: https://files.pythonhosted.org/packages/dd/8d/cb83551686b964377110e215740a75dca253100ef57d4b11f65613c83e13/ansible-8.2.0.tar.gz SHA256: 935a6921ffb034aa18e6507b49e401676cd15243d6faa5e05e221008bf725c97 Wheel package: https://files.pythonhosted.org/packages/37/12/77be5a84116e25cb0d6e0fb7e62fa02b8578319486466cb14035a13c115a/ansible-8.2.0-py3-none-any.whl SHA256: 4b0b4f301c9d42d39597d45fdd5c6844f4ae5beeb5c003659b9fc464246a14f5 Some important details --- Python wheels are now available for both Ansible 8 and ansible-core 2.15.x, resulting in significantly improved installation performance. In addition, Ansible 8 no longer installs some unnecessary files from the included Ansible collections such as tests or hidden files and directories to further improve installation performance and reduce the size on disk. These files are still available in the source tarball if necessary. The changelog for ansible-core 2.15.2 installed by this release of Ansible 8 can be found here: https://github.com/ansible/ansible/blob/v2.15.2/changelogs/CHANGELOG-v2.15.rst Collections which have opted-in to being a part of the Ansible 8 unified changelog will have an entry on this page: https://github.com/ansible-community/ansible-build-data/blob/main/8/CHANGELOG-v8.rst For collections which have not opted-in to the unified changelog, you may find more information on https://galaxy.ansible.com or the collection source repository. For example, the community.crypto collection is available at https://galaxy.ansible.com/community/crypto and you can find a link to the source repository under the "Repo" button at the top right. What's the schedule for new Ansible releases after 8.2.0? - Subscribe to the Bullhorn for all future release dates, announcements, and Ansible contributor community news. Visit this link to subscribe: https://bit.ly/subscribe-bullhorn You can find all past Bullhorn issues on the official wiki page: https://github.com/ansible/community/wiki/News#the-bullhorn Porting Help A unified porting guide for collections that have opted-in is available here: https://docs.ansible.com/ansible/devel/porting_guides/porting_guide_8.html Getting collection updates from Ansible 8 with older releases of ansible-core -- Ansible 8 includes ansible-core 2.15.x. Based on your requirements, you can get collection updates as they ship in the Ansible "batteries included" package while continuing to use older versions of ansible-core. An ansible-galaxy requirements file based on the collections from Ansible 8 has been made available for this use case: https://github.com/ansible-community/ansible-build-data/blob/main/8/galaxy-requirements.yaml After you download the requirements file, the collections can be installed by running this command: "ansible-galaxy collection install -r galaxy-requirements.yaml" On behalf of the Ansible community, thank you and happy automating! Cheers Ansible Community Team -- You received this message because you are subscribed to the Google Groups "Ansible Development" group. To unsubscribe from this group and stop receiving emails from it, send an email to ansible-devel+unsubscr...@googlegroups.com. To view this discussion on the web visit https://groups.google.com/d/msgid/ansible-devel/671a75b6-830f-4d73-a758-ee5efb4f476en%40googlegroups.com.
[ansible-devel] Release announcement: Ansible community package 9.1.0
# Release announcement: Ansible 9.1.0 Hello everyone, We're happy to announce the release of the Ansible 9.1.0 package! Ansible 9.1.0 includes ansible-core 2.16.1 as well as a curated set of Ansible collections that provide a vast number of modules and plugins. How to get it -- This release is available on PyPI and can be installed with pip: `$ python3 -m pip install ansible==9.1.0 --user` The sources for this release can be found here: Release tarball: https://files.pythonhosted.org/packages/eb/ab/e6993e1608fa911ee84dd0f29f494064f3b7f4a277f99608c9421a7a5ed4/ansible-9.1.0.tar.gz SHA256: 5ad94991fb0e0e53a770a9ffcf1b68047f61b2282d948a7d2682ecd8fb8fa1bf Wheel package: https://files.pythonhosted.org/packages/32/f0/f7a66e975b9edf511e7223fe8d5642b16f1147087d4acc3d1be788267b41/ansible-9.1.0-py3-none-any.whl SHA256: bd88f16ca4b4dadfec78723f982c0f04e5481c6be497ccb43ea3b40fded39126 Some important details This release includes the mitigation of security issue CVE-2023-5764. See the porting guide below for details. Python wheels are available for both Ansible 9 and ansible-core 2.16, resulting in significantly improved installation performance. In addition, Ansible 9 does not install some unnecessary files from the included Ansible collections such as tests or hidden files and directories. This further improves installation performance and reduces the size on disk. These files are still available in the source tarball if needed. Collections which have opted-in to being a part of the Ansible 9 unified changelog will have an entry on this page: https://github.com/ansible-community/ansible-build-data/blob/9.1.0/9/CHANGELOG-v9.rst For collections which have not opted-in to the unified changelog, you may find more information on https://docs.ansible.com/ansible/latest/collections or on the collection source repository. For example, the community.crypto collection is available at https://docs.ansible.com/ansible/latest/collections/community/crypto/index.html and you can find a link to the source repository under the "Repository(Sources)" button. The changelog for ansible-core 2.16 installed by this release of Ansible 9 can be found here: https://github.com/ansible/ansible/blob/v2.16.1/changelogs/CHANGELOG-v2.16.rst What's the schedule for new Ansible releases after 9.1.0? The next release roadmap can be found at https://docs.ansible.com/ansible/devel/roadmap/ansible_roadmap_index.html >From now on, the Ansible community package release schedule will follow the Ansible Core release schedule, including (for example) delays for holidays. This means Ansible releases happen every four weeks through most of the year, but release dates may be delayed when Ansible Core release is. For the upcoming holiday season, this means that there will be no Ansible release in early January, but instead on January 30th. Subscribe to the Bullhorn for all future release dates, announcements, and Ansible contributor community news. Visit this link to subscribe: https://bit.ly/subscribe-bullhorn You can find all past Bullhorn issues on the Ansible Community Forum at: https://forum.ansible.com/c/news/bullhorn/17 Join the new Ansible Community Forum to follow along and participate in all the project and release related discussions and announcements. Feel free to share your thoughts, feedback, ideas and concerns there. Register here to join the Ansible Forum: https://forum.ansible.com Porting Help -- A unified porting guide for collections that have opted-in is available here: https://docs.ansible.com/ansible/devel/porting_guides/porting_guide_9.html Getting collection updates from Ansible 9 with older releases of ansible-core - Ansible 9 includes ansible-core 2.16. Depending on your needs, you can get collection updates as they ship in the Ansible "batteries included" package while continuing to use older versions of ansible-core. An ansible-galaxy requirements file based on the collections from Ansible 9 has been made available for this use case: https://github.com/ansible-community/ansible-build-data/blob/9.1.0/9/galaxy-requirements.yaml After you download the requirements file, the collections can be installed by running this command: `ansible-galaxy collection install -r galaxy-requirements.yaml` Special Thanks - We would like to give a shoutout with a big THANK YOU to Maxwell G and Felix Fontein for making this release happen! On behalf of the Ansible community, thank you and happy automating! Cheers Ansible Community Team -- You received this message because you are subscribed to the Google Groups "Ansible Development" group. To unsubscribe from this group and stop receiving emails from it, send an email to ansible-devel