QuickStatements 3.0/Documentation/Reference
What is it?
[edit]Accordingly to the Diátaxis framework, reference documentation is every material that give technical description of a process and helps the reader to operate it in their work. It should be neutral, authoritative, and act as a map to be followed.
Here in QuickStatements 3.0, reference material is exemplified by our thorough code documentation at GitHub.
Backend processes
[edit]This type of material includes the GitHub Actions backend workflows for better performance and reliability
Integration of the Wikibase REST API
[edit]We documented the implementation and integration of the Wikibase REST API with the existing functionalities used in QuickStatements in the codebase
Performance metrics
[edit]Performance metrics are not part of reference documentation, but the process of obtaining them can be classified as such. Below we display some of the performance metrics for this project:
| Type of metric | Description |
|---|---|
| Performance* | Benchmarking with other tools |
| Performance | Number of commands and number of batches executed given a certain time interval |
| Performance | Average waiting time for a batch to start executing, when more than 3 batches are in execution at the same time |
| Performance | Average command execution time |
| Usage | Number of total successful edits in Wikidata |
| Usage | Number of batches/commands |
| Usage | Number of distinct editors executing batches |
| Usage | Average or maximum number of batches run in parallel |
| Maintenance** | Grafana, toolforge:tool-watch/tools/2024 etc |
| Maintenance** | Commands to track resources such as
$ kubectl exec -it $(kubectl get pods -n tool-qs-dev -o name| head -n1 | cut -d'/' -f2) -- vmstat -w -S M 10 $ kubectl top pods -n tool-qs-dev |
| * Explanation metric | |
| ** How-to guide metric for developers | |