Skip to content

Commit 0d2cc42

Browse files
Remove beta/experimental notices and rename Spotlight to Metrics Catalog (#557)
Generated-By: mintlify-agent Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
1 parent c1a297e commit 0d2cc42

11 files changed

Lines changed: 22 additions & 53 deletions

File tree

guides/developer/caching.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ These Lightdash features use caching (if it's enabled on your instance):
4545
- **Scheduled Deliveries** generate and use cached results for the saved chart or dashboard they belong to.
4646
- **Google Sheets syncs** also use cached results. If you need syncs to always return fresh data, be aware that enabling caching will cause syncs to deliver cached results until the cache expires.
4747
- **SQL runner queries** including saved SQL charts and dashboard SQL chart tiles are cached through the same execution path as metric-based charts. Note that the SQL runner does not have a UI button to force-refresh or invalidate the cache — results remain cached until the cache expires.
48-
- **Metrics Catalog and Spotlight** queries go through the same async query service and are cached like any other query.
48+
- **Metrics Catalog** queries go through the same async query service and are cached like any other query.
4949

5050
These Lightdash features DO NOT use caching:
5151

guides/lightdash-semantic-layer.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ One of the best things about Lightdash's semantic layer is how flexible it is. Y
6767

6868
The most common way to use the semantic layer is in the Lightdash app:
6969

70-
- Business users can [explore metrics quickly in Spotlight](/guides/metrics-catalog), a metrics-first experience curated by your data team
70+
- Business users can [explore metrics quickly in the Metrics Catalog](/guides/metrics-catalog), a metrics-first experience curated by your data team
7171
- For more complex queries, [query directly from tables](/get-started/exploring-data/using-explores) to select metrics and dimensions without needing to know the underlying data structure
7272
- Visualizations are generated based on the fields you select, and you can customize however you like
7373

guides/metrics-catalog.mdx

Lines changed: 4 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,14 @@
11
---
2-
title: "Spotlight"
2+
title: "Metrics Catalog"
33
sidebarTitle: "Overview"
4-
description: Spotlight is a suite of features designed to put Metrics front and center. It simplifies data exploration, making it easy for business users to focus on metrics without dealing with complex tables or time dimensions.
4+
description: Metrics Catalog is a suite of features designed to put Metrics front and center. It simplifies data exploration, making it easy for business users to focus on metrics without dealing with complex tables or time dimensions.
55
---
66

7-
<Info>
8-
**The Spotlight features are currently in beta.**
9-
10-
We're actively testing and improving them — some of the functionality might be subject to change.
11-
</Info>
12-
137
## Getting Started
148

15-
Spotlight features use your existing [Lightdash semantic layer](/guides/lightdash-semantic-layer) and metrics definitions, so you can get started today. Head to **Metrics** in the navigation bar to start exploring.
9+
Metrics Catalog features use your existing [Lightdash semantic layer](/guides/lightdash-semantic-layer) and metrics definitions, so you can get started today. Head to **Metrics** in the navigation bar to start exploring.
1610

17-
Spotlight is organized into two main views:
11+
Metrics Catalog is organized into two main views:
1812

1913
- **Catalog** — A searchable, filterable table of all your project metrics. Browse metrics by category, owner, or popularity, explore any metric over time in the Metrics Explorer, and curate what your business users see through `.yml` configuration.
2014

guides/metrics-catalog/catalog.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: "Catalog"
3-
description: "Browse, explore, and curate your metrics in the Spotlight Metrics Catalog."
3+
description: "Browse, explore, and curate your metrics in the Metrics Catalog."
44
---
55

66
## Browsing the catalog
@@ -49,11 +49,11 @@ Visualize your metrics in the **Metrics Explorer**.
4949

5050
7. **Drag to zoom:** Click and drag across the chart to highlight the desired time range or data points, then release to zoom in on that segment. Hit 'Reset Zoom' to reset chart.
5151

52-
## Curating Spotlight for your business users
52+
## Curating Metrics Catalog for your business users
5353

54-
Spotlight is designed to be a tool for your business users to explore and understand your data.
54+
Metrics Catalog is designed to be a tool for your business users to explore and understand your data.
5555

56-
To make Spotlight more useful for your business users, you can curate the metrics they can see and explore.
56+
To make Metrics Catalog more useful for your business users, you can curate the metrics they can see and explore.
5757

5858
To do this, you can:
5959

@@ -498,7 +498,7 @@ You can set a default owner for all metrics in a model. Metric-level owners over
498498
<Info>
499499
- Use the email address of a Lightdash user in your organization.
500500
- Metric-level owner takes precedence over model-level.
501-
- You can filter by owner in the Spotlight UI.
501+
- You can filter by owner in the Metrics Catalog UI.
502502
- If the email doesn't match a Lightdash user, the metric shows as "Unassigned".
503503
</Info>
504504

references/chart-types/custom-charts.mdx

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,9 @@
11
---
22
title: "Custom charts"
3-
description: "Custom charts are available in Beta for those that want additional customization and an extended library of charts. The charts are powered by [vega-lite](https://vega.github.io/vega-lite/examples) - the link will take you to some example galleries of what you can build using this powerful charting library. This includes heat maps, bubble plots, box plots and more."
3+
description: "Custom charts offer additional customization and an extended library of charts. The charts are powered by [vega-lite](https://vega.github.io/vega-lite/examples) - the link will take you to some example galleries of what you can build using this powerful charting library. This includes heat maps, bubble plots, box plots and more."
44
icon: "code"
55
---
66

7-
<Info>
8-
**Custom visualizations are a Beta feature.**
9-
10-
This means we have limited documentation and support. We may also change the way these options work in the future.
11-
</Info>
12-
13-
147
### Known limitations
158

169
These new Vega-lite powered charts offer enhanced flexibility and a broader range of visualizations, but there are important limitations to be aware of, particularly concerning interactivity and dashboard integration like:

references/chart-types/map.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: "Map (Beta)"
2+
title: "Map"
33
description: "Use maps to display geographic data on an interactive map."
44
icon: "earth-europe"
55
---

references/dimensions.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1880,7 +1880,7 @@ Tags are useful for:
18801880
- **Pipeline ingestion** — flag specific dimensions for downstream ETL or semantic layer workflows
18811881

18821882
<Note>
1883-
Tags are **not** displayed as Spotlight categories in the Lightdash UI. They function as a backend/programmatic control mechanism only.
1883+
Tags are **not** displayed as Metrics Catalog categories in the Lightdash UI. They function as a backend/programmatic control mechanism only.
18841884
</Note>
18851885

18861886
<Tabs>

references/lightdash-config-yml.mdx

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: "lightdash.config.yml reference"
3-
description: 'The lightdash.config.yml file allows you to configure project-wide settings for your Lightdash project, including spotlight, parameters, and defaults.'
3+
description: 'The lightdash.config.yml file allows you to configure project-wide settings for your Lightdash project, including Metrics Catalog, parameters, and defaults.'
44
sidebarTitle: "lightdash.config.yml"
55
---
66

@@ -20,7 +20,7 @@ The `lightdash.config.yml` file is an **optional** configuration file that allow
2020

2121
You **don't need** `lightdash.config.yml` to get started with Lightdash! This file is for users who want to:
2222

23-
- **Organize metrics in [Spotlight](/guides/metrics-catalog)** with custom categories and visibility settings
23+
- **Organize metrics in the [Metrics Catalog](/guides/metrics-catalog)** with custom categories and visibility settings
2424
- **Create parameters** that users can change to modify data across multiple charts and dashboards
2525

2626
If you're just getting started with Lightdash, you can skip this file and come back to it later when you want these advanced features.
@@ -48,7 +48,7 @@ Before creating a `lightdash.config.yml` file, make sure you have:
4848
```
4949
</Step>
5050
<Step title="Add your first configuration">
51-
Start with a simple configuration. Here's a basic example that sets up Spotlight categories:
51+
Start with a simple configuration. Here's a basic example that sets up Metrics Catalog categories:
5252

5353
```yaml
5454
# Basic lightdash.config.yml example
@@ -100,9 +100,9 @@ custom_granularities:
100100
```
101101

102102

103-
## Spotlight configuration
103+
## Metrics Catalog configuration
104104

105-
The `spotlight` section allows you to configure project-wide spotlight settings. This section is required in the lightdash.config.yml file.
105+
The `spotlight` section allows you to configure project-wide Metrics Catalog settings. This section is required in the lightdash.config.yml file.
106106

107107
```yaml
108108
spotlight:
@@ -118,14 +118,14 @@ spotlight:
118118

119119
| Property | Required | Value | Description |
120120
| :------------------- | :------- | :---------- | :---------- |
121-
| `default_visibility` | No | string enum | The default visibility of spotlight metrics. Defaults to `show`, can also be set to `hide`. |
122-
| `categories` | No | Object | Define the categories that can be used in Spotlight on your model yml files. |
121+
| `default_visibility` | No | string enum | The default visibility of Metrics Catalog metrics. Defaults to `show`, can also be set to `hide`. |
122+
| `categories` | No | Object | Define the categories that can be used in the Metrics Catalog on your model yml files. |
123123

124124
Each category in the `categories` object requires the following properties:
125125

126126
| Property | Required | Value | Description |
127127
| :------- | :------- | :---------- | :---------- |
128-
| `label` | Yes | string | The label of the category as it will be displayed in Spotlight. |
128+
| `label` | Yes | string | The label of the category as it will be displayed in the Metrics Catalog. |
129129
| `color` | No | string enum | The color of the category. If not provided, it will be set to gray. Allowed values: `gray`, `violet`, `red`, `orange`, `green`, `blue`, `indigo`, `pink`, `yellow`. |
130130

131131

references/table-calculation-functions/aggregate-functions.mdx

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,6 @@ title: "Aggregate functions"
33
description: "Built-in functions for referencing column and row totals in your table calculations."
44
---
55

6-
<Info>
7-
**Table calculation functions are an Experimental feature.**
8-
9-
These functions may change or be updated without notice as we iterate. See [feature maturity levels](/references/workspace/feature-maturity-levels) for details.
10-
</Info>
11-
126
Aggregate functions let you reference grand totals and row totals in your table calculations. Unlike [row functions](/references/table-calculation-functions/row-functions) and [pivot functions](/references/table-calculation-functions/pivot-functions) which compile to SQL window functions, aggregate functions generate separate CTEs that compute totals from the underlying data.
137

148
This means `total()` correctly handles all metric types — including `count_distinct` and `average` — by re-running the metric's native aggregation rather than naively summing grouped values.

references/table-calculation-functions/pivot-functions.mdx

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,6 @@ title: "Pivot functions"
33
description: "Built-in functions for accessing values across pivot columns in your table calculations."
44
---
55

6-
<Info>
7-
**Table calculation functions are an Experimental feature.**
8-
9-
These functions may change or be updated without notice as we iterate. See [feature maturity levels](/references/workspace/feature-maturity-levels) for details.
10-
</Info>
11-
126
Pivot functions let you work with values across pivot columns in your results table. When you pivot a dimension in Lightdash, the values of that dimension become separate columns — pivot functions give you a way to reference and aggregate across those columns.
137

148
<Note>

0 commit comments

Comments
 (0)