You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: website/docs/reference/resource-properties/description.md
+14-10Lines changed: 14 additions & 10 deletions
Original file line number
Diff line number
Diff line change
@@ -157,7 +157,7 @@ A user-defined description. Can be used to document:
157
157
- analyses, and analysis columns
158
158
- macros, and macro arguments
159
159
160
-
These descriptions are used in the documentation website rendered by dbt (see [the documentation guide](/docs/collaborate/documentation)).
160
+
These descriptions are used in the documentation website rendered by dbt (refer to [the documentation guide](/docs/collaborate/documentation) or [dbt Explorer](/docs/collaborate/explore-projects)).
161
161
162
162
Descriptions can include markdown, as well as the [`doc` jinja function](/reference/dbt-jinja-functions/doc).
163
163
@@ -265,7 +265,7 @@ Orders can be one of the following statuses:
| placed | The order has been placed but has not yet left the warehouse |
268
-
| shipped | The order has ben shipped to the customer and is currently in transit |
268
+
| shipped | The order has been shipped to the customer and is currently in transit |
269
269
| completed | The order has been received by the customer |
270
270
| returned | The order has been returned by the customer and received at the warehouse |
271
271
@@ -305,7 +305,13 @@ models:
305
305
306
306
307
307
### Include an image from your repo in your descriptions
308
-
To include an image from your repository in your descriptions:
308
+
309
+
This section applies to dbt Core users only. Including an image from your repository ensures your images are version-controlled.
310
+
311
+
Both dbt Cloud and dbt Core users can [include an image from the web](#include-an-image-from-the-web-in-your-descriptions), which offers dynamic content, reduced repository size, accessibility, and ease of collaboration.
312
+
313
+
To include an image in your model's `description` field:
314
+
309
315
1. Add the file in a subdirectory, e.g. `assets/dbt-logo.svg`
310
316
2. Set the [`asset-paths` config](/reference/project-configs/asset-paths) in your `dbt_project.yml` file so that this directory gets copied to the `target/` directory as part of `dbt docs generate`
311
317
@@ -336,19 +342,17 @@ models:
336
342
337
343
</File>
338
344
339
-
_[CLI users only]_
340
-
341
345
3. Run `dbt docs generate` — the `assets` directory will be copied to the `target` directory
342
346
343
347
4. Run `dbt docs serve` — the image will be rendered as part of your project documentation:
344
348
345
-
<Lightbox src="/img/reference/image-in-docs.png" title="The image at assets/dbt-logo.svg is rendered correctly"/>
346
-
347
-
If mixing images and text together, also consider using a docs block.
349
+
If mixing images and text, also consider using a docs block.
348
350
349
351
### Include an image from the web in your descriptions
350
352
351
-
Use the image URL to render the image.
353
+
This section applies to dbt Cloud and dbt Core users. Including an image from the web offers dynamic content, reduced repository size, accessibility, and ease of collaboration.
354
+
355
+
To include images from the web, specify the image URL in your model's `description` field:
352
356
353
357
<File name='models/schema.yml'>
354
358
@@ -367,5 +371,5 @@ models:
367
371
368
372
</File>
369
373
370
-
If mixing images and text together, also consider using a docs block.
374
+
If mixing images and text, also consider using a docs block.
0 commit comments