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

Update documentation to read from project perspective #351

Closed
jaredpetersen opened this issue Aug 26, 2021 · 3 comments
Closed

Update documentation to read from project perspective #351

jaredpetersen opened this issue Aug 26, 2021 · 3 comments

Comments

@jaredpetersen
Copy link
Contributor

jaredpetersen commented Aug 26, 2021

There's a couple of sections in the documentation that reads as if this is something that only a single person works on:

README.md

When I was working on a Zipkin PR I discovered a nice Java library called Testcontainers.
It provides an easy and clean API over the go docker sdk to run, terminate and connect to containers in your tests.
I found myself comfortable programmatically writing the containers I need to run an integration/smoke tests. So I started porting this library in Go.

docs/features/creating_container.md

When I have to describe TestContainer I say: "it is a wrapper around the docker daemon designed for tests."


I think it would be more appropriate to update the language to take more of a project perspective rather than from a single person. Here's a sample rewrite of the opening passage of the README:

Testcontainers-Go is a package that makes it simple to set up container-based dependencies for automated integration/smoke tests. The clean, easy-to-use API enables users to programmatically define containers that should be run as part of a test and clean up those resources when the test is done.

I'd be happy to put up a PR for this and other documentation-related issues. I think expanding the documentation and doing things like this would do a lot for the project.

PS -- I'd just like to say that I really appreciate the work that everyone has put in here. I'm a fan of Testcontainers on Java and was super happy to see that there was a Go equivalent. 🙂

Related Issues

@mdelapenya
Copy link
Member

Hey @jaredpetersen, indeed. I'd say that we can start working on a revamp of the docs, aligned with what you proposed in #112 (comment)

We are happy to help with the reviews finding the right alignment

@mdelapenya
Copy link
Member

I updated the description to include a section to auto close related issues

@mdelapenya
Copy link
Member

I think we can close this issue, as #353 was merged, so that the docs use a project-style instead of a personal one.

Thanks for the work here!

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

No branches or pull requests

2 participants