docs: improve consistency and fix typos #534
Conversation
kiview
left a comment
kiview
left a comment
There was a problem hiding this comment.
Thanks for the PR, very much appreciated.
mdelapenya
left a comment
mdelapenya
left a comment
There was a problem hiding this comment.
Thanks for improving the docs, it's super important for the project
LGTM
Codecov Report
@@ Coverage Diff @@
## main #534 +/- ##
==========================================
+ Coverage 68.71% 68.76% +0.04%
==========================================
Files 22 22
Lines 2148 2148
==========================================
+ Hits 1476 1477 +1
Misses 532 532
+ Partials 140 139 -1
📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
| # Build from Dockerfile | ||
|
|
||
| Testcontainers-go gives you the ability to build an image and run a container | ||
| Testcontainers-Go gives you the ability to build an image and run a container |
There was a problem hiding this comment.
@kiview I think we should standardize the naming to one of Testcontainers-Go or Testcontainers-go.
As we are not using Testcontainers-Java, I'd use the lowercase version for the language.
WDYT?
There was a problem hiding this comment.
I was wondering the same when I saw the PR. In Java, if we talk about the library in a more technical context, we tend to call it testcontainers-java, so all lowercase.
But the general name of the project is Testcontainers, so upper cased.
I think I am with you, when talking about Testcontainers-go in a more literate way, lower casing the language looks better.
There was a problem hiding this comment.
I can lower case it then! I am glad this discussion is being had because I have created presentations to sister teams at work on this pkg, and have often wondered which were the proper route to take.
Also, fwiw, I'll be presenting at GopherCon (US) on my team's integration testing solution which incorporates this pkg! So if there are ways of sharing that out to this community better, then I am all ears :)
There was a problem hiding this comment.
Also, fwiw, I'll be presenting at GopherCon (US) on my team's integration testing solution which incorporates this pkg! So if there are ways of sharing that out to this community better, then I am all ears :)
@sicoyle sure, please join our Slack so that we can have a more interactive conversation about it
It's amazing that you are sharing all that great stuff you are doing at this big conference. Congrats!
|
@kiview @mdelapenya I standardized the names that I searched and found in the docs to |
docs/features/garbage_collector.md
Outdated
| `Reaper` in this package) removes containers/networks/volumes created by | ||
| Testcontainers-Go after a specified delay. It is a project developed by the | ||
| Testcontainers-go after a specified delay. It is a project developed by the | ||
| TestContainers organization and is used across the board for many of the |
There was a problem hiding this comment.
| TestContainers organization and is used across the board for many of the | |
| Testcontainers organization and is used across the board for many of the |
There was a problem hiding this comment.
BTW, could you replace in this PR any reference to TestContainers? 🙏
- TestContainers
+ TestcontainersI can find them at:
- README.md
- testing.go
- gotest.md
There was a problem hiding this comment.
Oh yes, probably the most important change 😅
mdelapenya
left a comment
mdelapenya
left a comment
There was a problem hiding this comment.
LGTM!
Thanks for taking care of the docs! Great improvement 👏
|
@sicoyle thanks for the PR, which has started a positive, internal discussion on naming things (sum-up: projects Vs repos) 😄 We are going to merge this PR as is, and we will eventually update the names ourselves, to avoid causing you more work playing ping pong with the names Again, thanks for your work here. |
* main: Add system requirements parent docs page for podman and colima (#562) Support for cap-add/cap-drop (#555) fix container NetworkMode usage (#560) chore: use hashed versions of test-summary action (#556) chore: use container.State() function in tests (#543) Log docker server info (#548) docs: add docs regarding Colima usage (#547) chore: add emoji to breaking changes in release drafter (#542) chore: add CONTRIBUTING file (#539) issue #537 Rename the wait/multi.go file to wait/all.go (#541) docs: add a basic layout for wait strategies in docs (#536) docs: improve consistency and fix typos (#534) chore: do not skip test (#528) chore: include test flakiness in the release drafter (#535) chore: retire old versions of Go (#530)
3 participants
What does this PR do?
This PR is meant to improve consistency in documentation and make minor typo adjustments.
Why is it important?
Enhance dev understanding and readability in documentation.
Related issues
None