reflected collection documentation with now included roles

CHANGELOG.md

@@ -1,5 +1,7 @@
 # Zabbix Collection Changes
 
+## devel
+
 ## 0.1.0
   - Initial migration of Zabbix content from Ansible core (2.9 / devel), including content:
     - **Connection Plugins**:

CODE_OF_CONDUCT.md

@@ -55,8 +55,14 @@ further defined and clarified by project maintainers.
 ## Enforcement
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting the project team at [email protected]. All
-complaints will be reviewed and investigated and will result in a response that
+reported by contacting one of the project maintainers at:
+* [email protected]
+* [email protected]
+* [email protected]
+
+Or Ansible project directly at [email protected].
+
+All complaints will be reviewed and investigated and will result in a response that
 is deemed necessary and appropriate to the circumstances. The project team is
 obligated to maintain confidentiality with regard to the reporter of an incident.
 Further details of specific enforcement policies may be posted separately.

CONTRIBUTING.md

@@ -1,88 +1,171 @@
-# Contributing to this role
+# Contribution guidelines
 
 **Table of contents**
 
-- [Contributing to this role](#contributing-to-this-role)
+- [Contribution guidelines](#contribution-guidelines)
   * [Contributing](#contributing)
-  * [(local) Development](#-local--development)
-    + [Requirements](#requirements)
-    + [Execution](#execution)
-- [Other](#other)
+  * [Coding guidelines](#coding-guidelines)
+    + [Zabbix roles](#zabbix-roles)
+    + [Zabbix modules](#zabbix-modules)
+  * [Testing and Development](#testing-and-development)
+    + [Testing Zabbix roles](#testing-zabbix-roles)
+    + [Testing Zabbix modules](#testing-zabbix-modules)
+- [Additional information](#additional-information)
   * [Virtualenv](#virtualenv)
   * [Links](#links)
 
-Thank you very much for making time to improve this Ansible role.
+Thank you very much for taking time to improve this Ansible collection. We appreciate your every contribution. Please make sure you are familiar with the content presented in this document to avoid any delays during reviews or merge.
+
+Please note that this project is released with following codes of conduct and by participating in the project you agree to abide by them:
+* [Contributor Covenant Code of Conduct](CODE_OF_CONDUCT.md)
+* [Community Code of Conduct](https://docs.ansible.com/ansible/devel/community/code_of_conduct.html)
+
+If you are interested in joining us as a maintainer, please open an issue.
 
 ## Contributing
 
-Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms. [Contributor Code of Conduct](https://docs.ansible.com/ansible/devel/community/code_of_conduct.html).
+1. Fork this repository with community Zabbix collection.
+2. Create a new branch and apply your changes to it. In addition to that:
+    1. Ensure that any changes you introduce to this collection are reflected in the documentation.
+    2. Should your change introduce a new feature, module or bug fix, note it under `devel` section in [CHANGELOG](CHANGELOG.md).
+    3. Include tests with your contribution to ensure that future pull requests will not break your functionality.
+    4. Make sure that tests succeed.
+3. Push the branch to your forked repository.
+4. Submit a new pull request into this collection.
 
-1. Fork the repo
+*Notes:*
+* Pull requests that fail during the tests will not be merged. If you have trouble narrowing down cause of a failure and would like some help, do not hesitate to ask for it in comments.
+* If you plan to propose an extensive feature or breaking change, please open an issue first. This allows collection maintainers to comment on such change in advance and avoid possible rejection of such contribution.
 
-2. Create a branch and apply your changes to this branch.
+## Coding guidelines
 
-    a. Make sure you have updated the documentation when adding new variables;
-
-    b. Don't forget to add/update tests so we can test the functionality during each Pull Request;
-
-    c. Make sure the tests succeed.
+Style guides are important because they ensure consistency in the content, look, and feel of a book or a website. Any contributions to this collection must adhere to the following rules:
 
-3. Push the branch to your fork and submit a pull request.
+* [Ansible style guide](http://docs.ansible.com/ansible/latest/dev_guide/style_guide/).
+* Use "Ansible" when referring to the product and ``ansible`` when referring to the command line tool, package and so on.
 
-**Note**
+### Zabbix roles
 
-Pull Requests that fail during the tests will not be merged.
+* Playbooks should be written in multi-line YAML format using ``key: value``.
+  * The form ``key=value`` is suitable for ``ansible`` ad-hoc execution, not for ``ansible-playbook``.
+* Every task should always have a ``name:`` keyword associated with it.
 
-## Coding Guidelines
+### Zabbix modules
 
-Style guides are important because they ensure consistency in the content, look, and feel of a book or a website.
+These rules are required for any contributions proposing a new Zabbix module or updating an existing one. Modules should:
 
-* [Ansible Style Guide](http://docs.ansible.com/ansible/latest/dev_guide/style_guide/)
-* It's "Ansible" when referring to the product and ``ansible`` when referring to the command line tool, package, etc
-* Playbooks should be written in multi-line YAML with ``key: value``. The form ``key=value`` is only for ``ansible`` ad-hoc, not for ``ansible-playbook``.
-* Tasks should always have a ``name:``
+* Be compatible with [currently supported Zabbix releases](https://www.zabbix.com/life_cycle_and_release_policy).
+* Include the same set of general options as other Zabbix modules:
+  * In `DOCUMENTATION` block via `extends_documentation_fragment` keyword.
+  * In module `argument_spec` as a set of module parameters.
+* Implement proper logout mechanism as other modules do.
+* Use the same version of `zabbix-api` library as defined in collection requirements.
+* Comply with [Ansible module best practices](https://docs.ansible.com/ansible/devel/dev_guide/developing_modules_best_practices.html).
 
-## (local) Development
+## Testing and Development
 
-This role makes use of Molecule to test the execution of the role and verify it. In the root of the repository https://github.com/dj-wasabi/ansible-ci-base, a file named `requirements.txt` exists and contains the versions used by the tests.
+It is recommended to use Docker for the testing as this repository is utilizing it for its own CI. Read [Docker installation guide](https://docs.docker.com/install/) for more information.
 
-### Requirements
+Make sure you start your work on the current state of the repository with `master` branch up to date. The best way to both try new changes and run shipped tests is by cloning the repository to Ansible project:
 
-You can install them with the following command:
+```bash
+cd <ANSIBLE-PROJECT>/
+mkdir -p collections/ansible_collections/community
+git clone [email protected]:<USERNAME>/community.zabbix.git collections/ansible_collections/community/zabbix
+```
 
+Functionality can be verified by looking at the documentation of a module:
+```bash
+ansible-doc community.zabbix.zabbix_host
 ```
-pip install -r requirements.txt
+
+Once this is done, you can reference modules and roles from testing playbook likes this:
+
+```yaml
+- hosts: myserver
+  roles:
+    - role: community.zabbix.zabbix_agent
+      zabbix_agent_server: 10.0.0.1
+      ...
+
+  tasks:
+    - name: Configure Zabbix host
+      community.zabbix.zabbix_host:
+        server_url: http://10.0.0.1/
+        ...
+      delegate_to: localhost
 ```
 
-Once the dependencies are installed, please install Docker as Molecule is configured in this repository to create Docker containers. See [this](https://docs.docker.com/install/) link to install Docker on your system.
+### Testing Zabbix roles
+
+*This section is subject to change as our CI regarding roles is being reworked and may not work for you right now!*
 
-### Execution
+Roles make use of [Molecule](https://molecule.readthedocs.io/en/latest/) to verify and test the execution of each role. In order to start testing with Molecule, you need to install the required dependencies. Requirements file can be found in the root of the [dj-wasabi/ansible-ci-base](https://github.com/dj-wasabi/ansible-ci-base) repository.
 
-Once everything is installed, you can validate your changes by executing:
+It is recommended to create a [new Python virtual environment](#virtualenv) for this to not clutter your global Python installation. First, install the dependencies:
+
+```bash
+pip install -r requirements.txt
 ```
+
+Note that Docker is required when testing roles as Molecule is configured to use it. Once everything is installed, validate your role changes with:
+
+```bash
 molecule test
 ```
 
-It should run without any issues.
+### Testing Zabbix modules
+
+Modules are tested via `ansible-test` command. Configurations for integration and sanity tests for the command are contained within `tests` directory. Refer to the [official documentation](https://docs.ansible.com/ansible/latest/dev_guide/testing_integration.html) for introduction to module integration testing within Ansible. Please note that this may fail if you get your directory structure wrong. If this happens, please see the start of [Testing and Development](#testing-and-development) regarding the placement of the collection.
 
-# Other
+Running test suites locally requires a few dependencies to be installed. Same as for the roles, it is recommended to use [Python virtual environment](#virtualenv):
+
+```bash
+pip install docker-compose zabbix-api
+```
+
+Integration test suite for modules can be run with the commands below:
+
+```bash
+export zabbix_version=X.Y
+export zabbix_port=XY
+docker-compose up -d
+ansible-test integration -v --color --retry-on-error --continue-on-error --diff
+docker-compose down
+```
+*Notes*:
+* `zabbix_version=X.Y` will be expanded to Docker image `ubuntu-X.Y-latest`
+* `zabbix_port=XY` is the mapping port for the container (local port 8080 will be mapped to port XY on the zabbix-web container). As of now, this needs to be set explicitly as different versions of zabbix-web docker images are exposing different ports.
+* Details for both variables and values that are in use can be read from [ansible-test.yml](.github/workflows/ansible-test.yml).
+
+Sanity test suite for the modules can be run with the commands:
+
+```bash
+ansible-test sanity -v --color --docker --python 3.6
+```
+
+# Additional information
 
 ## Virtualenv
 
-Suggestion is to create a virtualenv so you won't have issues with other projects.
+It is recommended to use virtualenv for development and testing work to prevent any conflicting dependencies with other projects.
 
-Some web pages describing virtualenvs:
+A few resources describing virtualenvs:
 
 * http://thepythonguru.com/python-virtualenv-guide/
 * https://realpython.com/python-virtual-environments-a-primer/
 * https://www.dabapps.com/blog/introduction-to-pip-and-virtualenv-python/
 
 ## Links
 
-[Molecule](https://molecule.readthedocs.io/)
-
-[Ansible](https://www.ansible.com/)
-
-[Molecule V2 with your own role](https://werner-dijkerman.nl/2017/09/05/using-molecule-v2-to-test-ansible-roles/)
-
-**End note**: Have fun making changes. If a feature helps you, then others find it helpful too and I will happily have it merged. 
+* [Ansible](https://www.ansible.com/)
+* [Ansible style guide](http://docs.ansible.com/ansible/latest/dev_guide/style_guide/)
+* [Ansible module best practices](https://docs.ansible.com/ansible/devel/dev_guide/developing_modules_best_practices.html)
+* [Integration testing with `ansible-test`](https://docs.ansible.com/ansible/latest/dev_guide/testing_integration.html)
+* [Docker installation guide](https://docs.docker.com/install/)
+* [Molecule](https://molecule.readthedocs.io/)
+* [Molecule V2 with your own role](https://werner-dijkerman.nl/2017/09/05/using-molecule-v2-to-test-ansible-roles/)
+* [dj-wasabi/ansible-ci-base](https://github.com/dj-wasabi/ansible-ci-base)
+* [Current Zabbix releases](https://www.zabbix.com/life_cycle_and_release_policy)
+
+**End note**: Have fun making changes. If a feature helps you, others may find it useful as well and we will be happy to merge it.