Benchmark schema support

How to make your life easier while building your own benchmarks

For your convenience we recommend using editor with YAML validation against JSON schema; you can point your editor to docs/schema.json. We can recommend Visual Studio Code with redhat.vscode-yaml plugin.

You need to edit settings file to map benchmark configuration files (with .hf.yaml extension) to the schema, adding:

"yaml.schemas" : {
    "file:///path/to/hyperfoil-distribution/docs/schema.json" : "/*.hf.yaml"
},

Note that you can also directly point to the hosted JSON schema definition:

"yaml.schemas" : {
    "https://hyperfoil.io/schema.json" : "/*.hf.yaml"
},

Last modified September 2, 2024: docs: fix quickstart links (245525b)