Skip to content

Commit b05c4f4

Browse files
authored
remove image with old dbt logo (#4756)
this PR removes the image that contains the old dbt logo and clarifies a section applies to dbt core users. Resolves #4737
2 parents 5dfbff3 + b768f76 commit b05c4f4

File tree

1 file changed

+14
-10
lines changed

1 file changed

+14
-10
lines changed

website/docs/reference/resource-properties/description.md

Lines changed: 14 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -157,7 +157,7 @@ A user-defined description. Can be used to document:
157157
- analyses, and analysis columns
158158
- macros, and macro arguments
159159

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)).
161161

162162
Descriptions can include markdown, as well as the [`doc` jinja function](/reference/dbt-jinja-functions/doc).
163163

@@ -265,7 +265,7 @@ Orders can be one of the following statuses:
265265
| status | description |
266266
|----------------|---------------------------------------------------------------------------|
267267
| 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 |
269269
| completed | The order has been received by the customer |
270270
| returned | The order has been returned by the customer and received at the warehouse |
271271
@@ -305,7 +305,13 @@ models:
305305

306306

307307
### 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+
309315
1. Add the file in a subdirectory, e.g. `assets/dbt-logo.svg`
310316
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`
311317

@@ -336,19 +342,17 @@ models:
336342

337343
</File>
338344

339-
_[CLI users only]_
340-
341345
3. Run `dbt docs generate` — the `assets` directory will be copied to the `target` directory
342346

343347
4. Run `dbt docs serve` — the image will be rendered as part of your project documentation:
344348

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.
348350

349351
### Include an image from the web in your descriptions
350352

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:
352356

353357
<File name='models/schema.yml'>
354358

@@ -367,5 +371,5 @@ models:
367371

368372
</File>
369373

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.
371375

0 commit comments

Comments
 (0)