dbt-labs / dbt-labs/docs.getdbt.com

<Constant />, Term and other components inside code blocks render as literal tags

Open Beginner friendly
#9,770 0 comments 0 reactions 0 assignees View on GitHub
content improvement
Dominant language
JavaScript
Stars
215
Forks
1.2k
Avg merge
1d 15h
Merged PRs (30d)
130

Description

### Contributions

- [x] I have read the contribution docs, and understand what's expected of me.

### Link to the page on docs.getdbt.com requiring updates

- https://docs.getdbt.com/guides/zapier-slack
- https://docs.getdbt.com/guides/zapier-ms-teams
- https://docs.getdbt.com/guides/zapier-refresh-tableau-workbook
- https://docs.getdbt.com/guides/zapier-refresh-mode-report
- https://docs.getdbt.com/guides/databricks-workflows
- https://docs.getdbt.com/reference/commands/dbt-environment
- https://docs.getdbt.com/docs/local/connect-data-platform/watsonx-spark-setup
- https://docs.getdbt.com/faqs/Troubleshooting/ide-session-unknown-error

(And for ``):

- https://docs.getdbt.com/docs/build/sources#faqs-1 / https://docs.getdbt.com/docs/build/sources.md (`FAQs` -> `How do I snapshot freshness for one source only?`)
- https://docs.getdbt.com/reference/resource-properties/description?version=2.0#add-a-multiline-description-to-a-model

### What part(s) of the page would you like to see updated?

MDX doesn't process components inside fenced code blocks, so every `` written inside a code fence reaches readers as the raw tag. For example, the webhook validation sample in the Zapier guides shows:

```python
raise Exception("Calculated signature doesn't match contents of the Authorization header. This webhook may not have been sent from .")
```

The tag is HTML-escaped into the code block on the rendered page, so readers see it literally, and it also comes through in the generated per-page `.md`.

Occurrences (12), paths relative to `website/`, lines as of the current `current` branch:

| File | Line(s) | Context |
|---|---|---|
| [docs/guides/zapier-slack.md](https://github.com/dbt-labs/docs.getdbt.com/blob/current/website/docs/guides/zapier-slack.md#L89) | 89, 232 | Python comment + exception string |
| [docs/guides/zapier-ms-teams.md](https://github.com/dbt-labs/docs.getdbt.com/blob/current/website/docs/guides/zapier-ms-teams.md#L100) | 100 | Exception string |
| [docs/guides/zapier-refresh-tableau-workbook.md](https://github.com/dbt-labs/docs.getdbt.com/blob/current/website/docs/guides/zapier-refresh-tableau-workbook.md#L70) | 70, 108, 115 | Python comments + exception string |
| [docs/guides/zapier-refresh-mode-report.md](https://github.com/dbt-labs/docs.getdbt.com/blob/current/website/docs/guides/zapier-refresh-mode-report.md#L63) | 63, 102 | Python comment + exception string |
| [docs/guides/databricks-workflows.md](https://github.com/dbt-labs/docs.getdbt.com/blob/current/website/docs/guides/databricks-workflows.md#L86) | 86 | Python comment |
| [docs/reference/commands/dbt-environment.md](https://github.com/dbt-labs/docs.getdbt.com/blob/current/website/docs/reference/commands/dbt-environment.md#L41) | 41 | Example CLI output block |
| [docs/docs/local/connect-data-platform/watsonx-spark-setup.md](https://github.com/dbt-labs/docs.getdbt.com/blob/current/website/docs/docs/local/connect-data-platform/watsonx-spark-setup.md#L42) | 42 | `python -m pip install dbt-watsonx-spark` -- even rendered this would be wrong; the install target should be the literal package name `dbt-core` |
| [docs/faqs/Troubleshooting/ide-session-unknown-error.md](https://github.com/dbt-labs/docs.getdbt.com/blob/current/website/docs/faqs/Troubleshooting/ide-session-unknown-error.md#L12) | 12 | Error message quoted in a `shell` fence |

term:

| File | Line | Context |
|---|---|---|
| [docs/faqs/Snapshots/snapshotting-freshness-for-one-source.md](https://github.com/dbt-labs/docs.getdbt.com/blob/current/website/docs/faqs/Snapshots/snapshotting-freshness-for-one-source.md#L16) | 16 | Comment in a `shell` fence; the FAQ is included on the sources page |
| [docs/reference/resource-properties/description.md](https://github.com/dbt-labs/docs.getdbt.com/blob/current/website/docs/reference/resource-properties/description.md#L304) | 304 | `description:` text in a `yml` example fence |

### Additional information

See https://github.com/orgs/mdx-js/discussions/2288

Contributor guide

No contributing guide indexed for this repository

Research direction

Review the 12 markdown files and line references listed in the issue, then read the linked MDX discussion for the rendering behavior. Render the affected docs and inspect the generated per-page .md files; done means the code examples show the intended literal text rather than raw component tags, including the corrected dbt-core package name.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
Half a day
Activity status
Quiet
Clarity
Clearly specified
Newbie friendliness
78/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.