Skip to content

Commit

Permalink
Improve consistency of Testcontainers name in docs (#5866)
Browse files Browse the repository at this point in the history
  • Loading branch information
neslihanedes committed Sep 26, 2022
1 parent 459d2f6 commit de1a77e
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 4 deletions.
2 changes: 1 addition & 1 deletion docs/contributing_docs.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Contributing to documentation

The testcontainers-java documentation is a static site built with [MkDocs](https://www.mkdocs.org/).
The Testcontainers-java documentation is a static site built with [MkDocs](https://www.mkdocs.org/).
We use the [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/) theme, which offers a number of useful extensions to MkDocs.

In addition we use a [custom plugin](https://github.com/rnorth/mkdocs-codeinclude-plugin) for inclusion of code snippets.
Expand Down
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ Using Gradle 5.0 or higher, you can add the following to the `dependencies` sect
Testcontainers depends on other libraries (like docker-java) for it to work.
Some of them (JUnit, docker-java-{api,transport} and its transitive dependencies, JNA, visible-assertions and others) are part of our public API.
But there are also "private", implementation detail dependencies (e.g., docker-java-core, Guava, OkHttp, etc.) that are not exposed to public API but prone to conflicts with test code/application under test code.
As such, **these libraries are 'shaded' into the core testcontainers JAR** and relocated under `org.testcontainers.shaded` to prevent class conflicts.
As such, **these libraries are 'shaded' into the core Testcontainers JAR** and relocated under `org.testcontainers.shaded` to prevent class conflicts.

## Sponsors

Expand Down
4 changes: 2 additions & 2 deletions docs/modules/databases/orientdb.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Note that it's based on the [official Docker image](https://hub.docker.com/_/ori

## Usage example

Declare your Testcontainer as a `@ClassRule` or `@Rule` in a JUnit 4 test or as static or member attribute of a JUnit 5 test annotated with `@Container` as you would with other Testcontainers.
Declare your Testcontainers instance as a `@ClassRule` or `@Rule` in a JUnit 4 test or as static or member attribute of a JUnit 5 test annotated with `@Container` as you would with other Testcontainers.
You can call `getDbUrl()` OrientDB container and build the `ODatabaseSession` by your own, but a more useful `getSession()` method is provided.
On the JVM you would most likely use the [Java driver](https://github.com/).

Expand Down Expand Up @@ -39,7 +39,7 @@ The following example uses the JUnit 5 extension `@Testcontainers` and demonstra
}
```

You are not limited to Unit tests and can of course use an instance of the OrientDB Testcontainer in vanilla Java code as well.
You are not limited to Unit tests and can of course use an instance of the OrientDB Testcontainers implementation in vanilla Java code as well.


## Adding this module to your project dependencies
Expand Down

0 comments on commit de1a77e

Please sign in to comment.