Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added additional documentation on containers #268

Conversation

pffijt
Copy link
Collaborator

@pffijt pffijt commented Nov 27, 2022

This pull-request includes these changes:

  • Added pages for the documentation website
  • Enhancement of azurite, kafka and redis documentation.

For Kafka and Redis it doesn't include extensive documentation on the usage of the container, but it will be at least mentioned on the documentation website.

@codecov-commenter
Copy link

codecov-commenter commented Nov 27, 2022

Codecov Report

Merging #268 (dcce762) into master (6046ad6) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master     #268   +/-   ##
=======================================
  Coverage   86.20%   86.20%           
=======================================
  Files          28       28           
  Lines         783      783           
  Branches       57       57           
=======================================
  Hits          675      675           
  Misses         78       78           
  Partials       30       30           
Impacted Files Coverage Δ
testcontainers/arangodb.py 100.00% <ø> (ø)
testcontainers/azurite.py 83.33% <ø> (ø)
testcontainers/clickhouse.py 100.00% <ø> (ø)
testcontainers/elasticsearch.py 85.71% <ø> (ø)
testcontainers/kafka.py 96.42% <ø> (ø)
testcontainers/keycloak.py 100.00% <ø> (ø)
testcontainers/localstack.py 94.44% <ø> (ø)
testcontainers/mongodb.py 100.00% <ø> (ø)
testcontainers/mssql.py 100.00% <ø> (ø)
testcontainers/mysql.py 84.00% <ø> (ø)
... and 6 more

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

@pffijt pffijt changed the title updated sphinx paging and added some additional documentation Added additional documentation on containers Nov 27, 2022
@pffijt
Copy link
Collaborator Author

pffijt commented Nov 27, 2022

#256 Skipped Nginx since it is deprecated.

Copy link
Collaborator

@tillahoffmann tillahoffmann left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice, thank you for extending the documentation. One follow-up comment.

testcontainers/kafka.py Outdated Show resolved Hide resolved
testcontainers/neo4j.py Outdated Show resolved Hide resolved
testcontainers/rabbitmq.py Outdated Show resolved Hide resolved
testcontainers/azurite.py Outdated Show resolved Hide resolved
pffijt and others added 2 commits December 2, 2022 18:53
Co-authored-by: Till Hoffmann <tillahoffmann@gmail.com>
Co-authored-by: Till Hoffmann <tillahoffmann@gmail.com>
@pffijt pffijt force-pushed the task/updated-sphinx-build-and-added-some-documentation branch 2 times, most recently from cef0293 to a19630c Compare December 2, 2022 18:57
@pffijt pffijt force-pushed the task/updated-sphinx-build-and-added-some-documentation branch from a19630c to 6c4ab68 Compare December 2, 2022 19:27
docs/index.rst Outdated Show resolved Hide resolved
@tillahoffmann
Copy link
Collaborator

This is great, thank you!

@tillahoffmann tillahoffmann merged commit 28e3a47 into testcontainers:master Dec 6, 2022
@pffijt pffijt deleted the task/updated-sphinx-build-and-added-some-documentation branch December 7, 2022 09:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants