Configuration

Minimal configuration

All projects have a settings or configuration file written in YAML language. Simply add the folowing lines to the settings.yml to enable some of the features:

settings:
    name: analytics

Recommended: [configuration validation and auto-complete]

In order to minimize friction and maximize productivity, dexFreight provides its own [schema.json][^1] for docs.yml. If your editor supports YAML schema validation, it's definitely recommended to set it up:

Visual Studio Code

1.  Install [`vscode-yaml`][vscode-yaml] for YAML language support.
2.  Add the schema under the `yaml.schemas` key in your user or
    workspace [`settings.json`][settings.json]:

{
    "yaml.schemas": {
    "git clone [email protected]:dexfreight/schema.json": "docs.yml"
    },
    "yaml.customTags": [ // (1)!
    "!ENV scalar",
    "!ENV sequence",
    "tag:yaml.org,2002:python/name:materialx.emoji.to_svg",
    "tag:yaml.org,2002:python/name:materialx.emoji.twemoji",
    "tag:yaml.org,2002:python/name:pymdownx.superfences.fence_code_format"
    ]
}

1.  This setting is necessary if you plan to use [icons and emojis],
    or Visual Studio Code will show errors on certain lines.

Other

1.  Ensure your editor of choice has support for YAML schema validation.
2.  Add the following lines at the top of `docs.yml`:

# yaml-language-server: $schema=https://[email protected]:dexfreight/schema.json

Advanced configuration

Projects can have many configuration options. The setup section explains in great detail how to configure automations, alerts, observability and more. Ask one of our representatives about how to setup the advance configurations.