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

Split up the Global Configs page #3184

Closed
1 task done
matthewshaver opened this issue Apr 13, 2023 · 2 comments · Fixed by #3332
Closed
1 task done

Split up the Global Configs page #3184

matthewshaver opened this issue Apr 13, 2023 · 2 comments · Fixed by #3332
Assignees
Labels
Docs team Authored by the Docs team @dbt Labs docs-ia-refresh A dbt Labs Docs team project to improve the organization/navigation of the product docs. improvement Use this when an area of the docs needs improvement as it's currently unclear

Comments

@matthewshaver
Copy link
Contributor

Contributions

  • I have read the contribution docs, and understand what's expected of me.

What page(s) or areas on docs.getdbt.com are affected?

https://docs.getdbt.com/reference/global-configs

What changes are you suggesting?

This page is very long and difficult to parse. Splitting it up into individual reference pages similar to the List of Commands pages. The Global Configs doc would become a parent category with the individual articles broken up below it.

Additional information

No response

@matthewshaver matthewshaver added engineering improvement that requires site engineering help or back up improvement Use this when an area of the docs needs improvement as it's currently unclear docs-ia-refresh A dbt Labs Docs team project to improve the organization/navigation of the product docs. Docs team Authored by the Docs team @dbt Labs and removed engineering improvement that requires site engineering help or back up labels Apr 13, 2023
@matthewshaver matthewshaver self-assigned this Apr 13, 2023
@matthewshaver
Copy link
Contributor Author

Per Doug,
It would be helpful if all of these are grouped together on the same page. Or cross-link to each other if they get put on separate pages.

e.g., if they all stay on the same page, these sections should be near each other since they are all related to logging (and have similar explanations for new flags in v1.5):

https://docs.getdbt.com/reference/global-configs#log-formatting
https://docs.getdbt.com/reference/global-configs#debug-level-logging
https://docs.getdbt.com/reference/global-configs#use-colors

@mirnawong1
Copy link
Contributor

Giving some feedback on this too!

  • Def agree with your proposal, makes total sense.
  • One thing I'm. not clear about is whether this is for both cloud and core? these are all on the profiles.yml so it makes me think it's all cli.
  • I think you can prob use the autogenerated index for a landing page, with a small paragraph. However bear in mind that the doccarousel is going to merge soon so you can use that in the future too.

@matthewshaver matthewshaver linked a pull request May 18, 2023 that will close this issue
8 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Docs team Authored by the Docs team @dbt Labs docs-ia-refresh A dbt Labs Docs team project to improve the organization/navigation of the product docs. improvement Use this when an area of the docs needs improvement as it's currently unclear
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants