Skip to content

Commit 5ea8046

Browse files
committed
add guidance in adapters guide
1 parent 999b1ba commit 5ea8046

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

website/docs/guides/adapter-creation.md

+9-1
Original file line numberDiff line numberDiff line change
@@ -1108,7 +1108,7 @@ The following subjects need to be addressed across three pages of this docs site
11081108

11091109
| How To... | File to change within `/website/docs/` | Action | Info to Include |
11101110
|----------------------|--------------------------------------------------------------|--------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
1111-
| Connect | `/docs/core/connect-data-platform/{MY-DATA-PLATFORM}-setup.md` | Create | Give all information needed to define a target in `~/.dbt/profiles.yml` and get `dbt debug` to connect to the database successfully. All possible configurations should be mentioned. |
1111+
| Connect | `/docs/core/connect-data-platform/{MY-DATA-PLATFORM}-setup.md` | Create | Give all information needed to define a target in `~/.dbt/profiles.yml` and get `dbt debug` to connect to the database successfully. All possible configurations should be mentioned. |
11121112
| Configure | `reference/resource-configs/{MY-DATA-PLATFORM}-configs.md` | Create | What options and configuration specific to your data platform do users need to know? e.g. table distribution and indexing options, column_quoting policy, which incremental strategies are supported |
11131113
| Discover and Install | `docs/supported-data-platforms.md` | Modify | Is it a vendor- or community- supported adapter? How to install Python adapter package? Ideally with pip and PyPI hosted package, but can also use `git+` link to GitHub Repo |
11141114
| Add link to sidebar | `website/sidebars.js` | Modify | Add the document id to the correct location in the sidebar menu |
@@ -1123,6 +1123,14 @@ Below are some recent pull requests made by partners to document their data plat
11231123
- [SingleStore](https://github.com/dbt-labs/docs.getdbt.com/pull/1044)
11241124
- [Firebolt](https://github.com/dbt-labs/docs.getdbt.com/pull/941)
11251125

1126+
Note — Use the following re-usable component to auto-fill the frontmatter content on your new page:
1127+
1128+
```markdown
1129+
import SetUpPages from '/snippets/_setup-pages-intro.md';
1130+
1131+
<SetUpPages meta={frontMatter.meta} />
1132+
```
1133+
11261134
## Promote a new adapter
11271135

11281136
The most important thing here is recognizing that people are successful in the community when they join, first and foremost, to engage authentically.

0 commit comments

Comments
 (0)