Skip to content

Commit add4822

Browse files
authored
docs: Update the docs for Visual Model (#9304)
1 parent ab5a64e commit add4822

File tree

12 files changed

+198
-266
lines changed

12 files changed

+198
-266
lines changed

docs/pages/guides/dbt.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -321,7 +321,7 @@ You can easily customize measures, joins, and pre-aggregation that apply
321321
to this very cube, mapped to the `orders` dbt model, and have it
322322
side-by-side with other cubes, even of they don't come from dbt.
323323

324-
To inspect rendered cubes, you can use [Data Graph][ref-data-graph],
324+
To inspect rendered cubes, you can use [Visual Model][ref-visual-model],
325325
[Playground][ref-playground], or the [`meta` endpoint][ref-rest-api-meta]
326326
of the REST API.
327327

@@ -351,7 +351,7 @@ of the REST API.
351351
[ref-template-context]: /reference/python/cube#templatecontext-class
352352
[ref-primary-key]: /reference/data-model/dimensions#primary_key
353353
[ref-dimension-types]: /reference/data-model/types-and-formats#dimension-types
354-
[ref-data-graph]: /product/workspace/data-model#data-graph
354+
[ref-visual-model]: /product/workspace/visual-model
355355
[ref-playground]: /product/workspace/playground
356356
[ref-rest-api-meta]: /product/apis-integrations/rest-api/reference#v1meta
357357

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
module.exports = {
22
"superset": "Apache Superset",
3-
"metabase": "Metabase",
3+
"metabase": "Metabase",
44
"preset": "Preset",
55
"tableau": "Tableau"
66
}

docs/pages/product/data-modeling/concepts/working-with-joins.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -978,7 +978,7 @@ The root cause is that joins are [directed](#direction-of-joins) and there's no
978978
join path that goes *by join definitions in the data model* from `users` to
979979
`companies` or in the opposite direction.
980980

981-
In [Data Graph][ref-data-graph], you can see that both `users` and `companies`
981+
In [Visual Model][ref-visual-model], you can see that both `users` and `companies`
982982
are to the right of `companies_to_users`, meaning that there's no way to go
983983
from `users` to `companies` moving left to right or right to left:
984984

@@ -1047,7 +1047,7 @@ cubes:
10471047
</CodeTabs>
10481048

10491049
Now there's a join path that goes *by join definitions in the data model* from
1050-
`users` to `companies_to_users` to `companies`. [Data Graph][ref-data-graph]
1050+
`users` to `companies_to_users` to `companies`. [Visual Model][ref-visual-model]
10511051
also shows that you can reach `companies` from `cubes` by going left to right.
10521052

10531053
<Diagram src="https://ucarecdn.com/0736a570-c1c2-45b5-a806-e90a216ce202/" />
@@ -1057,4 +1057,4 @@ also shows that you can reach `companies` from `cubes` by going left to right.
10571057
[ref-schema-ref-joins-relationship]: /reference/data-model/joins#relationship
10581058
[self-many-to-many-no-assoc-table]: #many-to-many-relationship-without-an-associative-table
10591059
[self-join-direction]: /product/data-modeling/concepts/working-with-joins#directions-of-joins
1060-
[ref-data-graph]: /product/workspace/data-model#data-graph
1060+
[ref-visual-model]: /product/workspace/visual-model

docs/pages/product/data-modeling/dynamic/jinja.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,7 @@ Jinja templates.
1717
Please [track this issue](https://github.com/cube-js/cube/issues/8134).
1818

1919
As a workaround, you can view the resulting data model in
20-
[Playground](/product/workspace/playground) and
21-
[Data Graph](http://localhost:3000/product/workspace/data-model#data-graph).
20+
[Playground](/product/workspace/playground) and [Visual Model][ref-visual-model].
2221
You can also introspect the data model using the [`/v1/meta` REST API
2322
endpoint](/product/apis-integrations/rest-api/reference#v1meta).
2423

@@ -253,4 +252,5 @@ If you'd like to split your Python code into several files, see
253252
https://jinja.palletsprojects.com/en/3.1.x/templates/#macros
254253
[jinja-docs-autoescaping]: https://jinja.palletsprojects.com/en/3.1.x/api/#autoescaping
255254
[jinja-docs-filters-safe]: https://jinja.palletsprojects.com/en/3.1.x/templates/#jinja-filters.safe
256-
[ref-cube-dbt]: /reference/python/cube_dbt
255+
[ref-cube-dbt]: /reference/python/cube_dbt
256+
[ref-visual-model]: /product/workspace/visual-model

docs/pages/product/getting-started/cloud/create-data-model.mdx

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ environment.
3737

3838
In the previous section, we generated four cubes from the Snowflake schema. To
3939
see the data graph of these four cubes and how they are connected to each other,
40-
click the <Btn>Show Graph</Btn> button on the Data Model page.
40+
navigate to the <Btn>[Visual Model][ref-visual-model]</Btn> page.
4141

4242
Let's review the `orders` cube first and update it with additional dimensions
4343
and measures.
@@ -215,4 +215,5 @@ After saving, you can experiment with your newly created view in the Playground.
215215
In the next section, we will learn how to query our `orders_view` using a BI
216216
tool.
217217

218-
[ref-member-references]: /product/data-modeling/syntax#references
218+
[ref-member-references]: /product/data-modeling/syntax#references
219+
[ref-visual-model]: /product/workspace/visual-model

docs/pages/product/getting-started/databricks/create-data-model.mdx

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,8 +31,8 @@ safely make changes to your data model without affecting the production
3131
environment.
3232

3333
In the previous section, we generated four cubes. To see the data graph of these
34-
four cubes and how they are connected to each other, click the <Btn>Show
35-
Graph</Btn> button on the Data Model page.
34+
four cubes and how they are connected to each other, navigate to the
35+
<Btn>[Visual Model][ref-visual-model]</Btn> page.
3636

3737
Let's review the `orders` cube first and update it with additional dimensions
3838
and measures.
@@ -210,4 +210,5 @@ After saving, you can experiment with your newly created view in the Playground.
210210
In the next section, we will learn how to query our `orders_view` using a BI
211211
tool.
212212

213-
[ref-member-references]: /product/data-modeling/syntax#references
213+
[ref-member-references]: /product/data-modeling/syntax#references
214+
[ref-visual-model]: /product/workspace/visual-model

docs/pages/product/workspace.mdx

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -14,11 +14,10 @@ and are only available in Cube Cloud.
1414

1515
In Cube Cloud, you can:
1616

17-
- Use the [data model editor][ref-data-model] with the [development
18-
mode][ref-dev-mode] and [Rollup Designer][ref-rollup-designer] to build
19-
the data model of your semantic layer.
20-
- Use [Visual Modeler][ref-visual-modeler] to build and edit your data model
21-
using a canvas-based UI.
17+
- Use the code-first [data model editor][ref-data-model] or the no-code [Visual Model][ref-visual-model]
18+
editor to build and enhance the data model of your semantic layer.
19+
- Use the [development mode][ref-dev-mode] and [environments][ref-environments] to
20+
collaborate and test features before going to production.
2221
- Use [Playground][ref-playground] to run queries and test the data model.
2322
- Use [Chart Prototyping][ref-vizard] to generate code of a front-end
2423
application that works with Cube.
@@ -29,12 +28,11 @@ to BIs, spreadsheets, and other visualization tools.
2928
- Use [Query History][ref-query-history] to observe queries and their
3029
performance in real-time.
3130
- Use the [pre-aggregations page][ref-pre-aggs] to inspect pre-aggregations
32-
and their build history.
31+
and their build history. Add new pre-aggregations via [Rollup Designer][ref-rollup-designer].
3332
- Use [Performance Insights][ref-perf-insights] to analyze the performance
3433
of your deployment as a whole.
3534
- Use [Monitoring Integrations][ref-monitoring-integrations] to export logs and
3635
metrics to external monitoring tools.
37-
- Access the data model through different [environments][ref-environments].
3836
- Use the [access control page][ref-access-control] to manage users of your
3937
Cube Cloud account and [single sign-on][ref-sso].
4038
- Use [Audit Log][ref-audit-log] to review security-related events in your
@@ -80,4 +78,4 @@ With Cube Core, you can:
8078
[ref-semantic-catalog]: /product/workspace/semantic-catalog
8179
[ref-encryption-keys]: /product/workspace/encryption-keys
8280
[ref-cube-store-encryption]: /product/caching/running-in-production#data-at-rest-encryption
83-
[ref-visual-modeler]: /product/workspace/visual-modeler
81+
[ref-visual-model]: /product/workspace/visual-model

docs/pages/product/workspace/_meta.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ module.exports = {
22
"playground": "Playground",
33
"vizard": "Chart Prototyping",
44
"data-model": "Data Model",
5-
"visual-modeler": "Visual Modeler",
5+
"visual-model": "Visual Model",
66
"rollup-designer": "Rollup Designer",
77
"dev-mode": "Development mode",
88
"environments": "Environments",

docs/pages/product/workspace/data-model.mdx

Lines changed: 6 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,10 @@
1-
---
2-
redirect_from:
3-
- /cloud/cube-ide
4-
- /cloud/dev-tools/cube-ide
5-
- /cloud/workspace/cube-ide
6-
---
7-
81
# Data Model
92

10-
With the web-based data model editor, you can write and test and your Cube [data
11-
model][ref-data-modeling] from your browser.
3+
Data model editor provides the code-first experience for building and enhancing the
4+
[data model][ref-data-modeling] of your semantic layer from within your web browser.
5+
6+
Unlike the [Visual Model][ref-visual-model] editor, it provides the freedom to use all
7+
available data modeling features at the expense of a code-centric experience.
128

139
<SuccessBox>
1410

@@ -61,44 +57,6 @@ there are any unsaved changes:
6157
alt="Unsaved changes warning modal"
6258
/>
6359

64-
## Data Graph
65-
66-
<InfoBox>
67-
For Cube Cloud customers on the [Enterprise](https://cube.dev/pricing) tier,
68-
the Data Graph is replaced by [Visual Modeler][ref-visual-modeler].
69-
Please see the [Visual Modeler page][ref-visual-modeler] for more details.
70-
</InfoBox>
71-
72-
In addition to exploring the code of data model files, you can view the visual
73-
representation of the data model, including relations between cubes.
74-
Click <Btn>Show Graph</Btn> in the top right part of the data model editor to
75-
open Data Graph:
76-
77-
<Screenshot src="https://ucarecdn.com/30b7fa8c-fb9f-43fb-af1d-4ef98aae2829/" />
78-
79-
Data Graph visualizes [cubes][ref-cubes] and [joins][ref-joins] between them as
80-
an [entity-relationship diagram][wiki-erd] (ERD). It allows to have a bird's-eye
81-
view of the data model and visually detect connected parts, i.e., groups of
82-
cubes that don't have any relationships with other groups.
83-
84-
For clarity, only dimensions and custom SQL expressions used in joins are shown.
85-
Join [relationship types][ref-join-types] are depicted with the crow's foot
86-
notation:
87-
88-
- Dash represents `one` in `one_to_one` and `one_to_many` types
89-
- Crow's foot represents `many` in `one_to_many` and `many_to_one` types
90-
91-
You can pan and zoom the visualization, search cubes using the input box, hover
92-
over cubes to highlight their relationships, and click <Btn>Show Code</Btn> to
93-
view their code.
94-
95-
<video width="100%" controls>
96-
<source
97-
src="https://ucarecdn.com/2cc26fee-f94e-4328-bc46-297bfdd6e726/video.mp4"
98-
type="video/mp4"
99-
/>
100-
</video>
101-
10260
## Git integration
10361

10462
To add more Git branches to your Cube Cloud deployment and/or switch between
@@ -162,10 +120,6 @@ If you'd like to use the UI to create a pre-aggregation, you can click on the
162120
/>
163121

164122
[ref-data-modeling]: /product/data-modeling/overview
165-
[ref-cubes]: /reference/data-model/cube
166-
[ref-joins]: /reference/data-model/joins
167-
[ref-join-types]: /reference/data-model/joins#relationship
168-
[wiki-erd]: https://en.wikipedia.org/wiki/Entity–relationship_model
169123
[ref-rollup-designer]: /product/workspace/rollup-designer
170124
[ref-creating-deployment]: /product/deployment/cloud/deployments#creating-a-new-deployment
171-
[ref-visual-modeler]: /product/workspace/visual-modeler
125+
[ref-visual-model]: /product/workspace/visual-model

0 commit comments

Comments
 (0)