add info about + prefix and splits config page #6932
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
github-actions
bot
added
content
github-actions
bot
added
size: large
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
| @@ -1,5 +1,9 @@ | |||
| --- | |||
| title: Configs, properties, what are they? | |||
| sidebar_label: Configs and properties | |||
| intro_text: "Clarify the difference between properties and configs in dbt: properties describe resources, while configs control how dbt builds them in the warehouse" | |||
| description: "Clarify the difference between properties and configs in dbt: properties describe resources, while configs control how dbt builds them in the warehouse" | |||
There was a problem hiding this comment.
We're switching between "configs" in the title and descriptions and "configs" and "configurations" in the body. Should we include "Configurations" somewhere in the front matter or change them all to "configs"? Thinking about how search will be impacted
| @@ -1,8 +1,9 @@ | |||
| --- | |||
| description: "Reference guide for configuring the dbt_project.yml file." | |||
| intro_text: "The dbt_project.yml file is a required file for all dbt projects. It contains important information that tells dbt how to operate your project." | |||
There was a problem hiding this comment.
What's our best practice for intro text? Should it be describing the feature or describing what's on the page (for example "This is the reference page for configuring the dbt_project.yml, a required file for all dbt projects that contains important information that tells dbt how to operate your project."
There was a problem hiding this comment.
It's a little bit of both I'd say, intro text is probably a little longer than description
| @@ -96,6 +97,27 @@ vars: | |||
|
|
|||
| </File> | |||
|
|
|||
| ## The `+` prefix | |||
There was a problem hiding this comment.
This is already a separate ref page. Every use of + in the docs links to this page. Will this section cause confusion or hurt the search?
There was a problem hiding this comment.
Good catch, might be better to link to that page instead! Or i might turn it into a snippet so its available in multiple places
| --- | ||
| title: Define properties | ||
| sidebar_label: Define properties | ||
| intro_text: "Learn how to define properties for your resources in a properties.yml file" |
There was a problem hiding this comment.
Same question as above for best practices for intro text - Should our intro text be more descriptive than the descriptions?
|
For record keeping purposes, I suggest expanding the title and description of this PR since it touches a few more pages and sections than just the + prefix |
mirnawong1
changed the title
Co-authored-by: Matt Shaver <60105315+matthewshaver@users.noreply.github.com>
Co-authored-by: Matt Shaver <60105315+matthewshaver@users.noreply.github.com>
this pr adds info/blurb about the + prefix for dbt_project.yml
Resolves #4693
🚀 Deployment available! Here are the direct links to the updated files: