Skip to content

Conversation

@runleonarun
Copy link
Collaborator

@runleonarun runleonarun commented Nov 7, 2025

Closes https://dbtlabs.atlassian.net/browse/PRODDOCS-26

What are you changing in this pull request and why?

Making these consistent in the docs:

  • Config block or SQL config or SQL file config
  • dbt_project.yml or Project file
  • Property file/Property YAML/ YAML file
PNG image

Checklist


🚀 Deployment available! Here are the direct links to the updated files:

@runleonarun runleonarun requested a review from a team as a code owner November 7, 2025 20:32
@vercel
Copy link

vercel bot commented Nov 7, 2025

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Preview Updated (UTC)
docs-getdbt-com Ready Ready Preview Nov 10, 2025 10:52am

@github-actions github-actions bot added content Improvements or additions to content developer blog This content fits on the developer blog. guides Knowledge best suited for Guides Docs team Authored by the Docs team @dbt Labs labels Nov 7, 2025
Copy link
Contributor

@mirnawong1 mirnawong1 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

hey @runleonarun , really great intent and improvements! some small suggestions based on my understanding:

  • recommend using 'properties YAML file' instead of property file. this is because
    • it makes it clear that the file is a YAML file (consistent with the SQL file config naming)
    • using properties plural because there can be multiple properties and matches what we say in docs
  • Likewise, i suggest specifying project YAML file
  • SQL file config makes sense but because we use 'config' so often and its ingrained - i'd recommend 'SQL file config block' but thats too long! - so maybe when we're writing explanatory text, we should try to use “config block” naturally in the sentence.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

content Improvements or additions to content developer blog This content fits on the developer blog. Docs team Authored by the Docs team @dbt Labs guides Knowledge best suited for Guides

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants