Docs: README update to help new users#370
Conversation
|
|
||
| ```xml | ||
| <username>admin</username> | ||
| <password>password</password> |
There was a problem hiding this comment.
IMO, these are the obvious ones and somewhat self explanatory.
We should probably have additional docs on what the other fields in those configs do and how to adjust them.
For instance, it's possible to run on a select set of queries, or multiple workload phases with a single config, but that isn't super obviously documented IMO.
There was a problem hiding this comment.
I can see that they look obvious to experienced users but they are needed for a quick-start of benchbase so I'd like to keep them here if possible :)
Do you think it would be beneficial to add a new .README file to the config folder and explain the advanced things there? - Or move everything related to config there and add a quick navigation link to the new .README file in the github README?
There was a problem hiding this comment.
My point about those two parameters being obvious is that they're self explanatory once you know where to look, but the part about where the configs are may not be.
I would suggest that the Getting Started text get rewritten as something slightly more high-level like "adjusting the connection details in the config file" which includes basic commentary about both the JDBC URL and the credentials.
A separate ConfigDetails.md might be warranted that the main README.md links to for additional details, especially with external links to JDBC driver details.
I don't think the entire ConfigDetails.md is necessary for you to write here, but if you could start a stub of it with the above, then I think one of the benchbase experts can take up the rest from there.
Make sense?
|
@bpkroth Hey Brian, I finally found some time to make the changes we talked about. I hope that some of the benchbase-cracks can adapt the |
Hey everybody,
I am a new user of benchbase and I found it cumbersome to get everything running smoothly with a lack of documentation. Therefore I have decided to update the README.md slightly, such that new users of benchbase have an easier time getting started. The documentation should now provide enough information now to get started smoothly with benchbase.
My two small additions: