IntenseFinance/nosqlbench
3
0
Fork 0
mirror of https://github.com/nosqlbench/nosqlbench.git synced 2024-11-25 10:10:32 -06:00
Code Issues Packages Projects Releases Wiki Activity

doc improvements

Browse Source
This commit is contained in:
Jonathan Shook 2020-04-01 12:27:53 -05:00
parent d3ff46536a
commit 0d063c2f3b
2 changed files with 9 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
engine-docs/src/main/resources/docs-for-nb/nosqlbench/getting_support.md
View File

@ -3,7 +3,14 @@ title: Getting Support
weight: 10
---
# Built-In Docs
# 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:
@ -17,13 +24,6 @@ To read any topic, simply use the command:
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.
# 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!
## General Feedback
These guidelines are mirrored at the

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

@ -9,7 +9,7 @@ Welcome to the documentation for NoSQLBench. This is a power tool that emulates
that you can fast-track performance, sizing and data model testing without writing your own testing harness.
To get started right away, jump to the
[Quick Start Example](/index.html#/docs/02_getting_started.html) from the menu on the left.
[Quick Start Example](../getting_started/docs/index.md) 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/blob/master/DOWNLOADS.md).