Improve documentation of the crate

[DDtKey]

We need to enrich the crate with documentation

Depends on #1

Tasks

Preview Give feedback

1. Contribution guide - @ubiratansoares is assigned
2. Improve crate-level documentation (docs.rs)
3. Document usage of each existing module
4. Align readme with documentation
5. New issue template
6. Activate #![deny(missing_docs)] at crate level to avoid missing documentation

[ghost]

Anything I can do to help?

[DDtKey]

Two remaining tasks are:

• Document usage of each existing module
  We have a number of modules which has been moved from testcontainers repo, most of them don't have a documentation. Need to actualize and write a documentation like this:

  testcontainers-rs-modules-community/src/rabbitmq/mod.rs

  Lines 6 to 29 in 6a4d10a

  	/// Module to work with [`RabbitMQ`] inside of tests.
  	///
  	/// Starts an instance of RabbitMQ with the [`management-plugin`] started by default,
  	/// so you are able to use the [`RabbitMQ Management HTTP API`] to manage the configuration if the started [`RabbitMQ`] instance at test runtime.
  	///
  	/// This module is based on the official [`RabbitMQ docker image`].
  	///
  	/// # Example
  	/// ```
  	/// use testcontainers::clients;
  	/// use testcontainers_modules::rabbitmq;
  	///
  	/// let docker = clients::Cli::default();
  	/// let rabbitmq_instance = docker.run(rabbitmq::RabbitMq);
  	///
  	/// let amqp_url = format!("amqp://127.0.0.1:{}", rabbitmq_instance.get_host_port_ipv4(5672));
  	///
  	/// // do something with the started rabbitmq instance..
  	/// ```
  	///
  	/// [`RabbitMQ`]: https://www.rabbitmq.com/
  	/// [`management-plugin`]: https://www.rabbitmq.com/management.html
  	/// [`RabbitMQ Management HTTP API`]: https://www.rabbitmq.com/management.html#http-api
  	/// [`RabbitMQ docker image`]: https://hub.docker.com/_/rabbitmq

• Contribution guide

I would be glad for any help

[ghost]

Okay I'll have a go at adding documentation for the use of each module and submit a PR.

[ubiratansoares]

@DDtKey Is there anyone assigned to Contribution Guidelines? If not, I'd love helping with that! 🙂

[DDtKey]

No, feel free to take on this task!
Thank you!🙏

[DDtKey]

To actualize the state:
We still need to cover undocumented modules. But there is no need to document all of them at once.

I'm happy to accept PRs with documentation for 1 module at a time.