Skip to content

Commit c67009a

Browse files
nataliefiannrunleonarunmirnawong1
authored
Created a new dark mode document (#6776)
## What are you changing in this pull request and why? I have created a new Dark mode document for the rollout of the Dark mode theme set in the dbt Cloud UI. I have created a new page, added two images and updated the release notes to advise users of the new feature ## Checklist - [x] I have reviewed 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. - [ ] The topic I'm writing about is for specific dbt version(s) and I have versioned it according to the [version a whole page](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/single-sourcing-content.md#adding-a-new-version) and/or [version a block of content](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/single-sourcing-content.md#versioning-blocks-of-content) guidelines. - [x] I have added checklist item(s) to this list for anything anything that needs to happen before this PR is merged, such as "needs technical review" or "change base branch." - [x] The content in this PR requires a dbt release note, so I added one to the [release notes page](https://docs.getdbt.com/docs/dbt-versions/dbt-cloud-release-notes). <!-- PRE-RELEASE VERSION OF dbt (if so, uncomment): - [ ] Add a note to the prerelease version [Migration Guide](https://github.com/dbt-labs/docs.getdbt.com/tree/current/website/docs/docs/dbt-versions/core-upgrade) --> <!-- ADDING OR REMOVING PAGES (if so, uncomment): - [x] 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 --> <!-- vercel-deployment-preview --> --- 🚀 Deployment available! Here are the direct links to the updated files: - https://docs-getdbt-com-git-nfiann-darkmode-dbt-labs.vercel.app/docs/build/metricflow-commands - https://docs-getdbt-com-git-nfiann-darkmode-dbt-labs.vercel.app/docs/cloud/about-cloud/dark-mode - https://docs-getdbt-com-git-nfiann-darkmode-dbt-labs.vercel.app/docs/dbt-versions/release-notes <!-- end-vercel-deployment-preview --> --------- Co-authored-by: Leona B. Campbell <[email protected]> Co-authored-by: Mirna Wong <[email protected]>
1 parent a1d5f10 commit c67009a

File tree

5 files changed

+45
-0
lines changed

5 files changed

+45
-0
lines changed
Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
---
2+
title: "Change your dbt Cloud Theme"
3+
id: dark-mode
4+
description: "Learn about theme switching in dbt Cloud"
5+
sidebar_label: dbt Cloud dark mode
6+
image: /img/docs/dbt-cloud/using-dbt-cloud/dark-mode.png
7+
---
8+
9+
dbt Cloud supports **Light mode** (default), **Dark mode**, and **System mode** (respects your browser's theme for light or dark mode) under the **Theme** section of your user profile. You can seamlessly switch between these modes directly from the profile menu, customizing your viewing experience.
10+
11+
Your selected theme is stored in your user profile, ensuring a consistent experience across dbt Cloud.
12+
13+
Theme selection applies across all areas of dbt Cloud, including the [IDE](/docs/cloud/dbt-cloud-ide/develop-in-the-cloud), [dbt Explorer](/docs/collaborate/explore-projects), [environments](/docs/environments-in-dbt), [jobs](/docs/deploy/jobs), and more. Learn more about customizing themes in [Enable dark mode in dbt Cloud](/docs/cloud/about-cloud/dark-mode#enable-dark-mode-in-dbt-cloud).
14+
15+
## Prerequisites
16+
17+
- You have a dbt Cloud account. If you don’t, try [dbt Cloud for free!](https://www.getdbt.com/signup)
18+
- Dark mode is currently available on the Developer plan and will gradually be made available for all [plans](https://www.getdbt.com/pricing) in the future. Stay tuned for updates.
19+
20+
## Change themes in dbt Cloud
21+
22+
To switch to dark mode in the dbt Cloud UI, follow these steps:
23+
24+
1. Navigate to your account name at the bottom left of your account.
25+
2. Under **Theme**, select **Dark**.
26+
27+
<Lightbox src="/img/docs/dbt-cloud/using-dbt-cloud/dark-mode.png" width="70%" title="Enable dark mode" />
28+
29+
And that’s it! 🎉 Your chosen selected theme will follow you across all devices.
30+
31+
## Disable dark mode in dbt Cloud
32+
33+
To disable dark mode in the dbt Cloud UI, follow these steps:
34+
35+
1. Navigate to the three dots at the bottom right of the IDE.
36+
2. Select **Switch to light mode** from the menu.
37+
38+
<Lightbox src="/img/docs/dbt-cloud/using-dbt-cloud/theme-selection-in-the-ide.png" width="90%" title="Enable light mode" />
39+
40+
## Legacy dark mode
41+
42+
The **Switch to dark mode** menu item in the IDE will soon be deprecated. All users who have access to the IDE will default to **Light mode** upon signing in, but can easily switch to **Dark mode** from the user menu in the navigation. Once you switch to your new theme, it will apply to all of your devices.

website/docs/docs/dbt-versions/release-notes.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,8 @@ Release notes are grouped by month for both multi-tenant and virtual private clo
1818

1919
## January 2025
2020

21+
- **New**: Users can now switch themes directly from the user menu. We have added support for **Light mode** (default), **Dark mode**, and automatic theme switching based on system preferences. The selected theme is stored in the user profile and will follow users across all devices.
22+
- Dark mode is currently available on the Developer plan and will be available for all [plans](https://www.getdbt.com/pricing) in the future. We’ll be rolling it out gradually, so stay tuned for updates. For more information, refer to [dbt Cloud dark mode](/docs/cloud/about-cloud/dark-mode).
2123
- **Fix**: Fixed an issue where [saved queries](/docs/build/saved-queries) with no [exports](/docs/build/saved-queries#configure-exports) would fail with an `UnboundLocalError`. Previously, attempting to process a saved query without any exports would cause an error due to an undefined relation variable. Exports are optional, and this fix ensures saved queries without exports don't fail.
2224
- **New**: You can now query metric alias in dbt Semantic Layer [GraphQL](/docs/dbt-cloud-apis/sl-graphql) and [JDBC](/docs/dbt-cloud-apis/sl-jdbc) APIs.
2325
- For the JDBC API, refer to [Query metric alias](/docs/dbt-cloud-apis/sl-jdbc#query-metric-alias) for more information.

website/sidebars.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@ const sidebarSettings = {
3131
"docs/cloud/about-cloud/tenancy",
3232
"docs/cloud/about-cloud/access-regions-ip-addresses",
3333
"docs/cloud/about-cloud/browsers",
34+
"docs/cloud/about-cloud/dark-mode",
3435
],
3536
}, // About dbt Cloud directory
3637
{
Loading
Loading

0 commit comments

Comments
 (0)