You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+24-20Lines changed: 24 additions & 20 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,12 +7,10 @@ This repo hosts the `community.libvirt` Ansible Collection.
7
7
8
8
The collection includes the libvirt modules and plugins supported by Ansible
9
9
libvirt community to help the management of virtual machines and/or containers
10
-
via the [libvirt][1] API.
10
+
via the [libvirt](https://libvirt.org/) API.
11
11
12
12
This collection is shipped with the `ansible` package.
13
13
14
-
[1]: https://libvirt.org/
15
-
16
14
## Tested with Ansible
17
15
<!-- List the versions of Ansible the collection has been tested with. Must match what is in galaxy.yml. -->
18
16
@@ -28,6 +26,7 @@ This collection is shipped with the `ansible` package.
28
26
29
27
## Included content
30
28
<!-- Galaxy will eventually list the module docs within the UI, but until that is ready, you may need to either describe your plugins etc here, or point to an external docsite to cover that information. -->
@@ -95,26 +94,25 @@ The aspiration is to follow the following general guidelines:
95
94
- The collection plugins must provide the same coverage of python support as
96
95
the versions of Ansible supported.
97
96
- The versions of Ansible supported by the collection must be the same as
98
-
those in developed, or those maintained, as shown in the Ansible [Release and Maintenance][3] documentation.
97
+
those in developed, or those maintained, as shown in the Ansible [Release and Maintenance](https://docs.ansible.com/ansible/latest/reference_appendices/release_and_maintenance.html) documentation.
*[Ansible Community Guide](https://docs.ansible.com/ansible/latest/community/index.html)
104
+
*[Ansible Development Guide](https://docs.ansible.com/ansible/devel/dev_guide/index.html)
105
+
*[Ansible Collection Development Guide](https://docs.ansible.com/ansible/devel/dev_guide/developing_collections.html#contributing-to-collections)
106
106
107
107
### Local Testing
108
108
109
-
If you want to develop new content for this collection or improve what is
110
-
already here, the easiest way to work on the collection is to clone it into
111
-
one of the configured [COLLECTIONS_PATHS][5] and work on it there.
109
+
To learn how to test your pull request locally, refer to the [Quick-start guide](https://github.com/ansible/community-docs/blob/main/create_pr_quick_start_guide.rst#id3).
To learn how to test a pull request made by another person in your local environment, refer to the [Test PR locally guide](https://github.com/ansible/community-docs/blob/main/test_pr_locally_guide.rst).
114
112
115
-
### Testing with `ansible-test`
113
+
### Collection maintenance
116
114
117
-
TBD
115
+
Maintainers of this collection follow the [mainteiner guidelines](MAINTAINING.md).
118
116
119
117
### Publishing New Version
120
118
@@ -127,17 +125,23 @@ Basic instructions without release branches:
127
125
5. Monitor the release job on the [Zuul Status Dashboard](https://dashboard.zuul.ansible.com/t/ansible/status).
128
126
6. Verify that the new version is available on [Ansible Galaxy](https://galaxy.ansible.com/community/libvirt).
129
127
128
+
See the [Releasing guidelines](https://github.com/ansible/community-docs/blob/main/releasing_collections_without_release_branches.rst) to learn more.
129
+
130
130
## More Information
131
131
<!-- List out where the user can find additional information, such as working group meeting times, slack/IRC channels, or documentation for the product this collection automates. -->
132
132
133
133
### Communication
134
134
135
-
This is a small collection with a small number of contributors. As such, there
136
-
is no formal Ansible Working Group. To communicate with the maintainers, please
137
-
make contact via one of the following methods:
135
+
To communicate, we use:
136
+
137
+
- The `#ansible-community`[Libera.Chat](https://libera.chat/) IRC channel.
138
+
-[Issues](https://github.com/ansible-collections/libvirt/issues) in this repository.
139
+
140
+
We announce important development changes and releases through Ansible's [The Bullhorn newsletter](https://docs.ansible.com/ansible/devel/community/communication.html#the-bullhorn). If you are a collection developer, be sure you are subscribed.
141
+
142
+
We take part in the global quarterly [Ansible Contributor Summit](https://github.com/ansible/community/wiki/Contributor-Summit) virtually or in-person. Track [The Bullhorn newsletter](https://docs.ansible.com/ansible/devel/community/communication.html#the-bullhorn) and join us.
138
143
139
-
- IRC on [irc.libera.chat](https://libera.chat/) in the `#ansible-community` channel
140
-
-[Issues](https://github.com/ansible-collections/libvirt/issues) on Github
144
+
For more information about communication, refer to the [Ansible Communication guide](https://docs.ansible.com/ansible/devel/community/communication.html).
0 commit comments