doc updates

This commit is contained in:
Jonathan Shook 2020-03-23 09:06:23 -05:00
parent 7db5e7fcf6
commit eea7e6a2c6
7 changed files with 39 additions and 2 deletions

21
DOWNLOADS.md Normal file
View File

@ -0,0 +1,21 @@
# Getting NoSQLBench
## Latest Downloads
The latest release of NoSQLBench is always available from github releases.
- download latest [nb](https://github.com/nosqlbench/nosqlbench/releases/latest/download/nb), a linux binary
- (be sure to `chmod +x nb` once you download it)
- download latest [nb.jar](https://github.com/nosqlbench/nosqlbench/releases/latest/download/nb.jar), a
single-jar application.
- This requires java 12 or later, make sure your `java -version` command says that you are on Java 12 or later.
## Maven
The latest release of NoSQLBench is always available fro Maven Central.
You can find the [latest version with Maven central search](https://search.maven.org/search?q=g:io.nosqlbench).
## Additional Plans
- Docker -We have a docker build in the works. Stay tuned for the details.
- Github artifacts - We are planning to add this as another channel. Stay tuned.

View File

@ -4,6 +4,8 @@
**The Open Source, Pluggable, NoSQL Benchmarking Suite**
[Get it Here](DOWNLOADS.md)
## What is NoSQLBench?
NoSQLBench is a serious performance testing tool for the NoSQL ecosystem.

File diff suppressed because one or more lines are too long

View File

@ -5,6 +5,18 @@ weight: 10
# 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!
## NoSQLBench Slack
There is a new [slack channel](https://join.slack.com/t/nosqlbench/shared_invite/zt-cu9f2jpe-XiHN3SsUDcjkVgxaURFuaw) for NoSQLBench.
Please join it if you are a new or existing NoSQLBench user and help us get it going!
## General Feedback
These guidelines are mirrored at the [Submitting Feedback](https://github.com/nosqlbench/nosqlbench/wiki/Submitting-Feedback)
wiki page at the nosqlbench project site, which is also where any `[Submit Feedback]` links should will take you.

View File

@ -10,6 +10,8 @@ This means that you can fast-track performance, sizing and data model testing wi
To get started right away, jump to the [Quick Start Example](/index.html#/docs/02_getting_started.html) from the menu on the left.
To see the ways you can get NoSQLBench, check out the project site [DOWNLOADS.md](https://github.com/nosqlbench/nosqlbench/DOWNLOADS.md).
## What is NoSQLBench?
NoSQLBench is a serious performance testing tool for the NoSQL ecosystem.

View File

@ -14,7 +14,7 @@
<java.target.version>12</java.target.version>
<!-- properties for package versions -->
<antlr4.version>4.7.2</antlr4.version>
<antlr4.version>4.8</antlr4.version>
<ascii.data.version>1.2.0</ascii.data.version>
<assertj.java8.version>1.0.0m1</assertj.java8.version>
<commons.codec.version>1.14</commons.codec.version>

View File

@ -153,6 +153,7 @@
</execution>
</executions>
<configuration>
<shadedArtifactAttached>false</shadedArtifactAttached>
<transformers combine.children="append">
<transformer implementation="org.apache.maven.plugins.shade.resource.AppendingTransformer">
<resource>topics.md</resource>