IntenseFinance/nosqlbench
3
0
Fork 0
mirror of https://github.com/nosqlbench/nosqlbench.git synced 2025-02-25 18:55:28 -06:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'master' of https://github.com/nosqlbench/nosqlbench

Browse Source
This commit is contained in:
Jonathan Shook 2020-06-08 13:18:03 -05:00
commit 807cc22519
2 changed files with 21 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@ -45,6 +45,26 @@ We offer NoSQLBench as a new way of thinking about testing systems. It is not li
system. It is our wish to build a community of users and practice around this project so that everyone in the NoSQL
ecosystem can benefit from common concepts and understanding and reliable patterns of use.
## Getting Support
In general, our goals with NoSQLBench are to make the help systems and examples wrap around the users like a suit of armor, so that they feel capable of doing most things without having to ask for help. Please keep this in mind when looking for personal support form our community, and help us find those places where the docs are lacking. Maybe you can help us by adding some missing docs!
### Built-In Docs
The documentation for NoSQLBench is quite thorough. On the command line, you can see a list of built-in docs with the command:
`nb help topics`
To read any topic, simply use the command:
`nb help <topic>`
The documentation system you are looking at right now includes the same docs you can find above already and more. They are automatically included when NoSQLBench is built.
### NoSQLBench Slack
There is a new slack channel at nosqlbench.slack.com. In order to access the slack channel, you'll need an invite. You can get that through [this simple form](https://docs.google.com/forms/d/e/1FAIpQLSdUOJ8iAPqyxsLfh1nBBsKShI53RAeuzYW4bKExmRMWjj4ufQ/viewform), which will send you an invite in email: Slack Invite. This is just a simple google form that automates the invite process.
Please join it if you are a new or existing NoSQLBench user and help us get it going!
## Contributing
We are actively looking for contributors to help make NoSQLBench better. This is an ambitious project that is just

2
engine-docs/src/main/resources/docs-for-nb/drivers/index.md
View File

@ -10,7 +10,7 @@ are provided by the version of nosqlbench.
You can see this list at any time by running the command:
nb --list-driver-types
nb --list-drivers
Each one comes with its own built-in documentation. It can be accessed with this command: