-
Notifications
You must be signed in to change notification settings - Fork 472
Description
Richard Loveland (rmloveland) commented:
As noted by @nvanbenschoten in this discussion, our current set of charts on the CockroachDB Performance overview page contains things that were created at different times using different tools on an ad hoc basis. As a result, the appearance is inconsistent and the charts are hard to maintain.
Nathan also pointed out that we can resolve this by using data files and scripts that generate charts from those files.
We should address this issue so that it's easy to update our documented performance characteristics by a process something like the following (imaginary, TBD)
-
Generate CSV files that display performance output
-
Run a script that converts the CSV data to charts
-
PR the docs repo with the CSV files and images that will go in the docs
This will make it much easier for us to provide users with up-to-date performance information.
Estimated scope of work for this issue is:
-
Figure out what data files will look like, and where we will store them (e.g., a =data= directory in the docs repo?). There is already a CSV format in use by engineering, we should re-use that.
-
Figure out how we will generate charts from said data files (e.g., should we write a Python script that lives in the docs repo? re-use the R script linked from the discussion above?)
-
Work with people (engineers, PMs, etc.) to make sure the above is relatively easy to use and generates the results we want.
See also:
Jira Issue: DOC-658