New docs: minimal docs for modules that lack them

testcontainers / testcontainers-java

Testcontainers is a Java library that supports JUnit tests, providing lightweight, throwaway instances of common databases, Selenium web browsers, or anything else that can run in a Docker container.

https://testcontainers.org

MIT License

7.98k stars 1.64k forks source link

New docs: minimal docs for modules that lack them #1160

Open rnorth opened 5 years ago

rnorth commented 5 years ago

Improvement for the new mkdocs-based documentation.

I'd expect that this doesn't need to be done in one big PR; it could be several.

We need some basic docs and examples (pulled in using the codeinclude macro) for:

[ ] docs/modules/mockserver.md
[ ] docs/modules/nginx.md
[ ] docs/modules/pulsar.md

stale[bot] commented 5 years ago

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. If you believe this is a mistake, please reply to this comment to keep it open. If there isn't one already, a PR to fix or at least reproduce the problem in a test case will always help us get back on track to tackle this.

rnorth commented 2 years ago

Looks like the following modules still lack any kind of documentation, which is quite sad:

pulsar
rabbitmq

and JDBC modules (which could be viewed as 'inheriting' some docs, so aren't really a big deal):

cockroachdb
clickhouse
mysql
postgres