Splitting up global configs into pages #3332
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
✅ Deploy Preview for docs-getdbt-com ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
github-actions
bot
added
content
github-actions
bot
added
the
size: large
jtcohen6
reviewed
May 11, 2023
There was a problem hiding this comment.
@matthewshaver Very supportive of splitting up this page into meaningful subsets, and I like the groupings you've chosen!
Meta-level comment: The sub-pages on "CLI flags," "env vars," and "yaml configs" should be presented differently. These aren't about what you can configure, but rather how you can define these configurations. IMO it makes sense to keep these together, possibly still as part of the top-level page.
|
@matthewshaver Exciting that you are working on this! The Netlify preview failed, so I could only look at the code and not the actual web pages. There are a couple issues that would be awesome to address either in this PR or a follow-up: |
|
@matthewshaver how would you feel about converting this into a draft until it's ready for review? i.e., draft until it's able to build in Netlify, etc. |
|
@dbeatty10 Just wrapped up those pesky Netlify errors. It should pass on the next check and make the preview available! |
1 task
matthewshaver
commented
Jun 1, 2023
|
approving this for Matt to merge, and he said he'll tackle Doug's feedback in separate pr |
3 tasks
dbeatty10
added a commit
that referenced
this pull request
Oct 30, 2023
[Preview](https://docs-getdbt-com-git-dbeatty-global-configs-prec-329ad4-dbt-labs.vercel.app/reference/global-configs/about-global-configs) resolves #4362 ## What are you changing in this pull request and why? Two things: 1. When quickly scanning docs, make it easy to see the order of precedence for global configs 1. Include hyperlinks to the three different ways that a global config can be set ([user config](https://docs.getdbt.com/reference/global-configs/yaml-configurations), [environment variable](https://docs.getdbt.com/reference/global-configs/environment-variable-configs), [CLI flag](https://docs.getdbt.com/reference/global-configs/command-line-flags)) ### History [This](https://github.com/dbt-labs/docs.getdbt.com/blob/35a59491ffc6133a26e0c52b9a8e9a3f96d405f3/website/docs/reference/global-configs/about-global-configs.md) is the current page for "Global Configs", and [this](https://github.com/dbt-labs/docs.getdbt.com/blob/533637af17b296e17a19eb4582da0123ddc8b572/website/docs/reference/global-configs.md) was the page prior to #3332. ### 🎩 <img width="450" alt="image" src="https://github.com/dbt-labs/docs.getdbt.com/assets/44704949/2f9657a8-ab70-456e-8cb6-29d7030d1cbb"> ## Checklist - [x] Review the [Content style guide](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/content-style-guide.md) and [About versioning](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/single-sourcing-content.md#adding-a-new-version) so my content adheres to these guidelines. - [x] I have verified the preview renders correctly - [x] I have verified any new links work correctly --------- Co-authored-by: Matt Shaver <[email protected]>
2 tasks
mirnawong1
added a commit
that referenced
this pull request
Jan 23, 2024
[Preview](https://docs-getdbt-com-git-dbeatty-print-no-print-dbt-labs.vercel.app/reference/global-configs/print-output#suppress-print-messages-in-stdout) resolves #4776 ## What are you changing in this pull request and why? I checked from v1.7 back to v1.1, and I couldn't get either of these to work in any version: Up to 1.5: ```yaml config: no_print: true ``` 1.5 and after: ```yaml config: print: false ``` However, the `DBT_NO_PRINT` / `DBT_PRINT` environment variables and `--no-print` and `--print` CLI flags _do_ work. So I think the code example for `profiles.yml` was just accidentally introduced in the following PRs, and we should remove it because it's not actually an option for any versions. - #1319 - #3134 For additional context, see: - [Upgrading to v1.1](https://docs.getdbt.com/docs/dbt-versions/core-upgrade/upgrading-to-v1.1#advanced-and-experimental-functionality) - [Upgrading to v1.5](https://docs.getdbt.com/docs/dbt-versions/core-upgrade/upgrading-to-v1.5#behavior-changes) - #1102 - dbt-labs/dbt-core#4701 - #3122 - #3332 ## Checklist - [x] Review the [Content style guide](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/content-style-guide.md) so my content adheres to these guidelines. - [x] For [docs versioning](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/single-sourcing-content.md#about-versioning), review how to [version a whole page](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/single-sourcing-content.md#adding-a-new-version) and [version a block of content](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/single-sourcing-content.md#versioning-blocks-of-content).
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What are you changing in this pull request and why?
The
global-configsreference guide had become a single page of increasing size. This breaks it down into individual pages which will make the content a little easier to find, especially when using the search functions.Most of the features in the original one-shot get their own page but some gather multiple sections into a single page. Specifically:
print-outputlogsparsingChecklist
Uncomment if you're publishing docs for a prerelease version of dbt (delete if not applicable):
Add versioning components, as described in Versioning Docs
Review the Content style guide and About versioning so my content adheres to these guidelines.
Add a checklist item for anything that needs to happen before this PR is merged, such as "needs technical review" or "change base branch."
Adding new pages (delete if not applicable):
website/sidebars.jsRemoving or renaming existing pages (delete if not applicable):
website/sidebars.jswebsite/static/_redirects