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.

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

Fixing Examples #5206

Merged
merged 6 commits into from
Apr 26, 2024
Merged

Fixing Examples #5206

merged 6 commits into from
Apr 26, 2024

Conversation

matthewshaver
Copy link
Contributor

What are you changing in this pull request and why?

Removing brackets from a few examples as they tend to cause confusion.
Also updated some placeholder text to match our style guide for examples

Checklist

Adding or removing pages (delete if not applicable):

  • Add/remove page in website/sidebars.js
  • Provide a unique filename for new pages
  • Add an entry for deleted pages in website/vercel.json
  • Run link testing locally with npm run build to update the links that point to deleted pages

@matthewshaver matthewshaver requested review from dataders and a team as code owners April 1, 2024 21:03
Copy link

vercel bot commented Apr 1, 2024

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 Apr 26, 2024 9:28pm

@github-actions github-actions bot added 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 labels Apr 1, 2024
Copy link
Collaborator

@runleonarun runleonarun left a comment

Choose a reason for hiding this comment

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

Hey @matthewshaver I know you wanted to get the crucial examples, but it might be more confusing if we don't change all examples at least on a page.

I suggest we clean up these pages completely then chip away at other config and setup pages. What do you think?

Copy link
Collaborator

@runleonarun runleonarun left a comment

Choose a reason for hiding this comment

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

@matthewshaver approved with a question for ya!

@@ -30,7 +30,7 @@ dbt-hive supports two transport mechanisms:
- binary
- HTTP(S)

The default mechanism is `binary`. To use HTTP transport, use the boolean option `use_http_transport: [true / false]`.
The default mechanism is `binary`. To use HTTP transport, use the boolean option. For example, `use_http_transport: true`.
Copy link
Collaborator

Choose a reason for hiding this comment

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

@matthewshaver I changed this to be an example for clarity.

Compute2:
http_path:[`/some/other/path']
http_path: /SOME/OTHER/PATH

```

Copy link
Collaborator

Choose a reason for hiding this comment

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

I noticed the profile.yml Under Selecting compute per model also uses the <profile-name> but maybe we should change all profile.yml and project.yml examples in one PR to reduce confusion. what do you think?

@matthewshaver matthewshaver merged commit 1a9d1f2 into current Apr 26, 2024
11 checks passed
@matthewshaver matthewshaver deleted the examples branch April 26, 2024 21:28
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 Docs team Authored by the Docs team @dbt Labs size: medium This change will take up to a week to address
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants