Skip to content

Commit

Permalink
clarify mf doc (#4445)
Browse files Browse the repository at this point in the history
folding in @WilliamDee's feedback from #4426
  • Loading branch information
mirnawong1 authored Nov 13, 2023
2 parents 0cb4856 + cf000cc commit f9cefe7
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 6 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ metrics:
Use [MetricFlow commands](/docs/build/metricflow-commands#metricflow) for metric validation or queries during development, and apply the following conventions based on your environment:
- For dbt Cloud, use the `dbt sl` prefix before the command (such as, `dbt sl parse` or `dbt sl query`).
- For dbt Cloud, use the `dbt sl` prefix before the command (such as, `dbt sl query`).
- For dbt Core, use the `mf` prefix (such as `mf validate-configs` or `mf query)`.

Follow these best practices when updating your semantic layer code, using the `mf` command as an example (replace `mf` with `dbt sl` if you're using dbt Cloud):
Expand Down
12 changes: 7 additions & 5 deletions website/docs/docs/build/metricflow-commands.md
Original file line number Diff line number Diff line change
Expand Up @@ -179,8 +179,9 @@ Options:

### Validate-configs

This command performs validations against the defined semantic model configurations:
<!--dbt sl validate-configs # In dbt Cloud-->
The following command performs validations against the defined semantic model configurations.

Note, in dbt Cloud you don't need to validate the Semantic Layer config separately. Running a dbt command (such as `dbt parse`, `dbt build`, `dbt compile`, `dbt run`) automatically checks it.

```bash

Expand All @@ -205,11 +206,12 @@ Options:

### Health checks

This command performs a health check against the data platform you provided in the configs:
<!--dbt sl health-checks # In dbt Cloud-->
The following command performs a health check against the data platform you provided in the configs.

Note, in dbt Cloud the `health-checks` command isn't required since it uses dbt Cloud's credentials to perform the health check.

```bash
mf health-checks #in dbt Core
mf health-checks # In dbt Core
```

### Tutorial
Expand Down

0 comments on commit f9cefe7

Please sign in to comment.