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

Improve Tempto Documentation #162

Open
mattsfuller opened this issue Sep 7, 2016 · 1 comment
Open

Improve Tempto Documentation #162

mattsfuller opened this issue Sep 7, 2016 · 1 comment

Comments

@mattsfuller
Copy link

Update documentation for Tempto and give examples of tests, so that others (non-TD) can write tests and contribute to OpenCI.
Tempto README.md does not explain:
How to populate the 'ssh' properties in the configuration file
How to use the new "multiple JDBC table managers" feature.
There are probably other features missing from the readme. I understand example tests have been created for each new feature. That is helpful, but these features need to be documented also.
The readme file is getting rather large. It might be time to split it into multiple files. Maybe one for "quick start", which would explain how to run the sample tests, one for creating Java tests, and another for creating convention based tests.

@mattsfuller
Copy link
Author

[ ] Document possible possible header options for query file in convention based tests
[ ] More verbose documentation on defining multiple databases for same table manager type
[ ] Make README more navigable

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

1 participant