Skip to content

Commit 5af0a75

Browse files
authored
Remove old docs (#890)
* Update deprecated 'docs' files * Remove Vagrantfile, as it's well out of date * Update RELEASING.md to reflect current truth
1 parent e541ee3 commit 5af0a75

File tree

5 files changed

+8
-45
lines changed

5 files changed

+8
-45
lines changed

AUTHORS

+3-12
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,3 @@
1-
Richard North <[email protected]>
2-
Gurpreet Sohal <[email protected]>
3-
Alex Boldt <[email protected]>
4-
Robert Požarickij <[email protected]>
5-
Matthieu Baechler <[email protected]>
6-
Krystian Nowak <[email protected]>
7-
Viktor Schulz <[email protected]>
8-
Asaf Mesika <[email protected]>
9-
Sergei Egorov <[email protected]>
10-
Pete Cornish <[email protected]>
11-
Miguel Gonzalez Sanchez <[email protected]>
12-
Julien LAMY <[email protected]>
1+
This file is deprecated. Please see the [contributors](https://github.com/testcontainers/testcontainers-java/graphs/contributors) listing.
2+
3+
[Richard North](https://github.com/rnorth), [Sergei Egorov](https://github.com/bsideup) and [Kevin Wittek](https://github.com/kiview) are the core maintainers.

README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -20,4 +20,4 @@ MS SQL Server module is (c) 2017 - 2018 G DATA Software AG and other authors.
2020

2121
Hashicorp Vault module is (c) 2017 Capital One Services, LLC and other authors.
2222

23-
See [AUTHORS](AUTHORS) for all contributors.
23+
See [contributors](https://github.com/testcontainers/testcontainers-java/graphs/contributors) for all contributors.

RELEASING.md

+3-2
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,9 @@ Testcontainers' release process is automated as a Travis deployment. This descri
88
1. Ensure that the [`CHANGELOG`](CHANGELOG.md) file is up to date and includes all merged features.
99
1. Create a new release on GitHub. **The tag name is used as the version**, so please keep the tag name plain (e.g. 1.2.3).
1010
1. Check that the Travis build passed.
11-
1. Release of published artifacts is fully automated. Once the Travis build completes, there are no further actions to perform on the repository.
12-
1. When available through Maven Central, poke [@whichrich](https://twitter.com/whichrich) to announce the release on Twitter!
11+
1. Release of published artifacts to Bintray is fully automated.
12+
1. After successful publication to Bintray, the artifacts must be synced to Maven Central.
13+
1. When available through Maven Central, poke [Richard North](https://github.com/rnorth) to announce the release on Twitter!
1314

1415
## Internal details
1516

Vagrantfile

-18
This file was deleted.

docs/ROADMAP.md

+1-12
Original file line numberDiff line numberDiff line change
@@ -10,16 +10,5 @@ Exact future features aren't set in stone, but here are the principles we should
1010
* In line with the above, we should aim for feature completeness soon.
1111
* Similarly, it should leverage good things that already exist (like reliable public Docker images) and be composable with other tools.
1212
* That said, don't lock us in to more third-party components than absolutely necessary, and only use well maintained dependencies.
13-
* It must be possible for a developer to use _or build_ this library with just minimal standard tools (Java JDK, Maven), and a local Docker environment. Do not use any non-public dependencies in the core lib or standard modules. (see the `proprietary-deps` maven profile for how we're dealing with the Oracle XE module that has a test-time dependency on the properitary Oracle JDBC driver JAR)
13+
* It must be possible for a developer to use _or build_ this library with just minimal standard tools (Java JDK, Maven), and a local Docker environment. Do not use any non-public dependencies in the core lib or standard modules.
1414

15-
## Future goals/anti-goals
16-
17-
This list may cross over with the [issues list](https://github.com/testcontainers/testcontainers-java/issues) some times.
18-
19-
* **Better documentation and log messages**. We need this.
20-
* **Database state snapshotting**. Some projects have complex test data that is time consuming to reload. This means that either testing takes a very long time (test data has to be reloaded often), or tests aren't sufficiently independent (test data is not reloaded and therefore tests aren't independent). Testcontainers should provide a way to snapshot DB state and quickly reload that state. Docker [native Checkpoint/Restore In Userspace](http://blog.kubernetes.io/2015/07/how-did-quake-demo-from-dockercon-work.html) looks like the best way to accomplish this.
21-
* **Support docker images pulled from private registries**
22-
* **Support integration testing in other languages/environments**. .NET and NodeJS seem like sensible options here.
23-
* **Allow a JUnit @Rule to point to a local `Dockerfile` rather than an imagename**. Perhaps.
24-
* **Don't enter the build tools space**
25-
* **Don't become involved in live run-time environments**. This is a tool for testing. Some features could technically be misused in a live environment, but this isn't something we should want to support.

0 commit comments

Comments
 (0)