Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

adjust docs config page #4529

Merged
merged 7 commits into from
Dec 19, 2023
Merged

adjust docs config page #4529

merged 7 commits into from
Dec 19, 2023

Conversation

mirnawong1
Copy link
Contributor

@mirnawong1 mirnawong1 requested a review from a team as a code owner November 22, 2023 12:33
@vercel Vercel
Copy link

vercel bot commented Nov 22, 2023 •
edited
Loading

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
docs-getdbt-com ✅ Ready (Inspect) Visit Preview 💬 Add feedback Dec 19, 2023 1:34pm

@github-actions github-actions bot added size: medium This change will take up to a week to address content Improvements or additions to content Docs team Authored by the Docs team @dbt Labs and removed size: medium This change will take up to a week to address labels Nov 22, 2023
@mirnawong1
Copy link
Contributor Author

hey @dbeatty10 , created this pr per our discussion in the #3989 (comment) pr

@mirnawong1 mirnawong1 requested a review from dbeatty10 November 22, 2023 12:36
@github-actions github-actions bot added the size: medium This change will take up to a week to address label Nov 29, 2023
@mirnawong1 mirnawong1 mentioned this pull request Nov 29, 2023
Merged
dbeatty10
dbeatty10 approved these changes Dec 17, 2023
View reviewed changes
Copy link
Contributor

@dbeatty10 dbeatty10 left a comment

Choose a reason for hiding this comment

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

The content looks accurate and preview looks good 👍

Two non-blocking suggestions:

  • flip order of examples of properties.yml and dbt_project.yml so that dbt_project.yml comes first (just like in #4456)
  • remove 2nd reference to /reference/macro-properties so that it isn't doubled-up

website/docs/reference/resource-configs/docs.md
<!----
To-do: check this
--->
You can use the docs property in YAML files, _except_ in `dbt_project.yml`. Refer to [Macro properties](/reference/macro-properties) for more info.
Copy link
Contributor

Choose a reason for hiding this comment

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

After this change, I'd suggest removing this line below so that we're not referring to it back-to-back:

Also refer to [macro properties](/reference/macro-properties).

@mirnawong1 mirnawong1 enabled auto-merge December 19, 2023 13:23
@mirnawong1 mirnawong1 merged commit 1b3f543 into current Dec 19, 2023
7 checks passed
@mirnawong1 mirnawong1 deleted the mwong-docs-configs branch December 19, 2023 13:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@dbeatty10 dbeatty10 dbeatty10 approved these changes

Assignees
No one assigned
Labels
content Improvements or additions to content Docs team Authored by the Docs team @dbt Labs size: medium This change will take up to a week to address
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@mirnawong1 @dbeatty10