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

create develop section on sidebar #4503

Merged
merged 34 commits into from
Nov 29, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
34 commits
Select commit Hold shift + click to select a range
ff5a401
move sidebar
mirnawong1 Nov 17, 2023
aac0f6b
add redirects and adjust links
mirnawong1 Nov 17, 2023
c1c3b46
fix links
mirnawong1 Nov 17, 2023
4df3bf6
fix link
mirnawong1 Nov 17, 2023
6c6a891
rephrase
mirnawong1 Nov 17, 2023
d193aa6
Merge branch 'current' into create-develop-sidebar
mirnawong1 Nov 17, 2023
9e65fc6
fix links
mirnawong1 Nov 17, 2023
a2a2b17
fix next
mirnawong1 Nov 17, 2023
634980a
Merge branch 'current' into create-develop-sidebar
mirnawong1 Nov 17, 2023
4f7c337
This branch was auto-updated!
github-actions[bot] Nov 17, 2023
eb0d5ef
This branch was auto-updated!
github-actions[bot] Nov 17, 2023
b00f276
This branch was auto-updated!
github-actions[bot] Nov 17, 2023
16ee21a
This branch was auto-updated!
github-actions[bot] Nov 17, 2023
8673b8d
This branch was auto-updated!
github-actions[bot] Nov 17, 2023
96d892f
This branch was auto-updated!
github-actions[bot] Nov 20, 2023
ea768c8
This branch was auto-updated!
github-actions[bot] Nov 20, 2023
2947bc0
This branch was auto-updated!
github-actions[bot] Nov 20, 2023
a2c5100
This branch was auto-updated!
github-actions[bot] Nov 20, 2023
e65822c
Update website/sidebars.js
mirnawong1 Nov 27, 2023
ab2d316
Merge branch 'current' into create-develop-sidebar
mirnawong1 Nov 27, 2023
6c6c063
tweak language
mirnawong1 Nov 27, 2023
bceb671
fix link
mirnawong1 Nov 27, 2023
051491c
This branch was auto-updated!
github-actions[bot] Nov 28, 2023
35450ca
This branch was auto-updated!
github-actions[bot] Nov 28, 2023
b6a6277
This branch was auto-updated!
github-actions[bot] Nov 28, 2023
c6e444f
adjust
mirnawong1 Nov 28, 2023
6cf3096
This branch was auto-updated!
github-actions[bot] Nov 28, 2023
ad92200
Merge branch 'current' into create-develop-sidebar
mirnawong1 Nov 28, 2023
186174f
Update vercel.json
mirnawong1 Nov 28, 2023
65937cd
adjust ia based on feedback
mirnawong1 Nov 28, 2023
3c84d71
This branch was auto-updated!
github-actions[bot] Nov 28, 2023
cba29c6
This branch was auto-updated!
github-actions[bot] Nov 29, 2023
32a4dc4
This branch was auto-updated!
github-actions[bot] Nov 29, 2023
7a8fb62
This branch was auto-updated!
github-actions[bot] Nov 29, 2023
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions website/docs/docs/about-setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,14 +21,14 @@ To begin configuring dbt now, select the option that is right for you.

<Card
title="dbt Cloud setup"
body="Learn how to connect to a data platform, integrate with secure authentication methods, configure a sync with a git repo, how to use the IDE, and how to install the dbt Cloud CLI."
body="Learn how to connect to a data platform, integrate with secure authentication methods, and configure a sync with a git repo."
link="/docs/cloud/about-cloud-setup"
icon="dbt-bit"/>

<Card
title="dbt Core installation"
body="Learn how to connect install dbt Core using Pip, Homebrew, Docker, or the open source repo."
link="/docs/core/installation"
title="dbt Core setup"
body="Learn about dbt Core and how to setup data platform connections."
link="/docs/core/about-core-setup"
icon="dbt-bit"/>

</div>
2 changes: 1 addition & 1 deletion website/docs/docs/build/build-metrics-intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Use MetricFlow in dbt to centrally define your metrics. As a key component of th

MetricFlow allows you to:
- Intuitively define metrics in your dbt project
- Develop from your preferred environment, whether that's the [dbt Cloud CLI](/docs/cloud/cloud-cli-installation), [dbt Cloud IDE](/docs/cloud/dbt-cloud-ide/develop-in-the-cloud), or [dbt Core](/docs/core/installation)
- Develop from your preferred environment, whether that's the [dbt Cloud CLI](/docs/cloud/cloud-cli-installation), [dbt Cloud IDE](/docs/cloud/dbt-cloud-ide/develop-in-the-cloud), or [dbt Core](/docs/core/installation-overview)
- Use [MetricFlow commands](/docs/build/metricflow-commands) to query and test those metrics in your development environment
- Harness the true magic of the universal dbt Semantic Layer and dynamically query these metrics in downstream tools (Available for dbt Cloud [Team or Enterprise](https://www.getdbt.com/pricing/) accounts only).

Expand Down
2 changes: 1 addition & 1 deletion website/docs/docs/build/metricflow-commands.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ tags: [Metrics, Semantic Layer]

Once you define metrics in your dbt project, you can query metrics, dimensions, and dimension values, and validate your configs using the MetricFlow commands.

MetricFlow allows you to define and query metrics in your dbt project in the [dbt Cloud CLI](/docs/cloud/cloud-cli-installation), [dbt Cloud IDE](/docs/cloud/dbt-cloud-ide/develop-in-the-cloud), or [dbt Core](/docs/core/installation). To experience the power of the universal [dbt Semantic Layer](/docs/use-dbt-semantic-layer/dbt-sl) and dynamically query those metrics in downstream tools, you'll need a dbt Cloud [Team or Enterprise](https://www.getdbt.com/pricing/) account.
MetricFlow allows you to define and query metrics in your dbt project in the [dbt Cloud CLI](/docs/cloud/cloud-cli-installation), [dbt Cloud IDE](/docs/cloud/dbt-cloud-ide/develop-in-the-cloud), or [dbt Core](/docs/core/installation-overview). To experience the power of the universal [dbt Semantic Layer](/docs/use-dbt-semantic-layer/dbt-sl) and dynamically query those metrics in downstream tools, you'll need a dbt Cloud [Team or Enterprise](https://www.getdbt.com/pricing/) account.

MetricFlow is compatible with Python versions 3.8, 3.9, 3.10, and 3.11.

Expand Down
33 changes: 0 additions & 33 deletions website/docs/docs/cloud/about-cloud-develop.md

This file was deleted.

3 changes: 1 addition & 2 deletions website/docs/docs/cloud/about-cloud-setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,14 +13,13 @@ dbt Cloud is the fastest and most reliable way to deploy your dbt jobs. It conta
- Configuring access to [GitHub](/docs/cloud/git/connect-github), [GitLab](/docs/cloud/git/connect-gitlab), or your own [git repo URL](/docs/cloud/git/import-a-project-by-git-url).
- [Managing users and licenses](/docs/cloud/manage-access/seats-and-users)
- [Configuring secure access](/docs/cloud/manage-access/about-user-access)
- Configuring the [dbt Cloud IDE](/docs/cloud/about-cloud-develop)
- Installing and configuring the [dbt Cloud CLI](/docs/cloud/cloud-cli-installation)

These settings are intended for dbt Cloud administrators. If you need a more detailed first-time setup guide for specific data platforms, read our [quickstart guides](/guides).

If you want a more in-depth learning experience, we recommend taking the dbt Fundamentals on our [dbt Learn online courses site](https://courses.getdbt.com/).

## Prerequisites

- To set up dbt Cloud, you'll need to have a dbt Cloud account with administrator access. If you still need to create a dbt Cloud account, [sign up today](https://getdbt.com) on our North American servers or [contact us](https://getdbt.com/contact) for international options.
- To have the best experience using dbt Cloud, we recommend you use modern and up-to-date web browsers like Chrome, Safari, Edge, and Firefox.

Expand Down
30 changes: 30 additions & 0 deletions website/docs/docs/cloud/about-develop-dbt.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
---
title: About developing in dbt
id: about-develop-dbt
description: "Learn how to develop your dbt projects using dbt Cloud."
sidebar_label: "About developing in dbt"
pagination_next: "docs/cloud/about-cloud-develop-defer"
hide_table_of_contents: true
---

Develop dbt projects using dbt Cloud, which offers a fast and reliable way to work on your dbt project. It runs dbt Core in a hosted (single or multi-tenant) environment.

You can develop in your browser using an integrated development environment (IDE) or in a dbt Cloud-powered command line interface (CLI).

<div className="grid--2-col" >

<Card
title="dbt Cloud CLI"
body="Allows you to develop and run dbt commands from your local command line or code editor against your dbt Cloud development environment."
link="/docs/cloud/cloud-cli-installation"
icon="dbt-bit"/>

<Card
title="dbt Cloud IDE"
body="Develop directly in your browser, making dbt project development efficient by compiling code into SQL and managing project changes seamlessly using an intuitive user interface."
link="/docs/cloud/dbt-cloud-ide/develop-in-the-cloud"
icon="dbt-bit"/>

</div><br />

To get started with dbt development, you'll need a [dbt Cloud](https://www.getdbt.com/signup) account and developer seat. For a more comprehensive guide about developing in dbt, refer to our [quickstart guides](/guides).
2 changes: 1 addition & 1 deletion website/docs/docs/connect-adapters.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Explore the fastest and most reliable way to deploy dbt using dbt Cloud, a hoste

Install dbt Core, an open-source tool, locally using the command line. dbt communicates with a number of different data platforms by using a dedicated adapter plugin for each. When you install dbt Core, you'll also need to install the specific adapter for your database, [connect to dbt Core](/docs/core/about-core-setup), and set up a `profiles.yml` file.

With a few exceptions [^1], you can install all [Verified adapters](/docs/supported-data-platforms) from PyPI using `python -m pip install adapter-name`. For example to install Snowflake, use the command `python -m pip install dbt-snowflake`. The installation will include `dbt-core` and any other required dependencies, which may include both other dependencies and even other adapter plugins. Read more about [installing dbt](/docs/core/installation).
With a few exceptions [^1], you can install all [Verified adapters](/docs/supported-data-platforms) from PyPI using `python -m pip install adapter-name`. For example to install Snowflake, use the command `python -m pip install dbt-snowflake`. The installation will include `dbt-core` and any other required dependencies, which may include both other dependencies and even other adapter plugins. Read more about [installing dbt](/docs/core/installation-overview).

[^1]: Here are the two different adapters. Use the PyPI package name when installing with `pip`

Expand Down
7 changes: 4 additions & 3 deletions website/docs/docs/core/about-core-setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,17 +3,18 @@ title: About dbt Core setup
id: about-core-setup
description: "Configuration settings for dbt Core."
sidebar_label: "About dbt Core setup"
pagination_next: "docs/core/about-dbt-core"
pagination_next: "docs/core/dbt-core-environments"
pagination_prev: null
---

dbt Core is an [open-source](https://github.com/dbt-labs/dbt-core) tool that enables data teams to transform data using analytics engineering best practices. You can install dbt locally in your environment and use dbt Core on the command line. It can communicate with databases through adapters.

This section of our docs will guide you through various settings to get started:

- [About dbt Core](/docs/core/about-dbt-core)
- [Installing dbt](/docs/core/installation)
- [Connecting to a data platform](/docs/core/connect-data-platform/profiles.yml)
- [How to run your dbt projects](/docs/running-a-dbt-project/run-your-dbt-projects)

To learn about developing dbt projects in dbt Cloud or dbt Core, refer to [Develop dbt](/docs/cloud/about-develop-dbt).
- **Note** &mdash; dbt Cloud provides a command line interface with the [dbt Cloud CLI](/docs/cloud/cloud-cli-installation). Both the open-sourced dbt Core and the dbt Cloud CLI are command line tools that let you run dbt commands. The key distinction is the dbt Cloud CLI is tailored for dbt Cloud's infrastructure and integrates with all its [features](/docs/cloud/about-cloud/dbt-cloud-features).

If you need a more detailed first-time setup guide for specific data platforms, read our [quickstart guides](https://docs.getdbt.com/guides).
25 changes: 0 additions & 25 deletions website/docs/docs/core/about-dbt-core.md

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: "About profiles.yml"
id: profiles.yml
---

If you're using [dbt Core](/docs/core/about-dbt-core), you'll need a `profiles.yml` file that contains the connection details for your data platform. When you run dbt Core from the command line, it reads your `dbt_project.yml` file to find the `profile` name, and then looks for a profile with the same name in your `profiles.yml` file. This profile contains all the information dbt needs to connect to your data platform.
If you're using [dbt Core](/docs/core/installation-overview), you'll need a `profiles.yml` file that contains the connection details for your data platform. When you run dbt Core from the command line, it reads your `dbt_project.yml` file to find the `profile` name, and then looks for a profile with the same name in your `profiles.yml` file. This profile contains all the information dbt needs to connect to your data platform.

For detailed info, you can refer to the [Connection profiles](/docs/core/connect-data-platform/connection-profiles).

Expand Down
2 changes: 1 addition & 1 deletion website/docs/docs/core/docker-install.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ You might also be able to use Docker to install and develop locally if you don't

### Prerequisites
* You've installed Docker. For more information, see the [Docker](https://docs.docker.com/) site.
* You understand which database adapter(s) you need. For more information, see [About dbt adapters](/docs/core/installation#about-dbt-adapters).
* You understand which database adapter(s) you need. For more information, see [About dbt adapters](docs/core/installation-overview#about-dbt-data-platforms-and-adapters).
* You understand how dbt Core is versioned. For more information, see [About dbt Core versions](/docs/dbt-versions/core).
* You have a general understanding of the dbt, dbt workflow, developing locally in the command line interface (CLI). For more information, see [About dbt](/docs/introduction#how-do-i-use-dbt).

Expand Down
38 changes: 28 additions & 10 deletions website/docs/docs/core/installation-overview.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,35 @@
---
title: "About installing dbt"
id: "installation"
title: "About dbt Core and installation"
description: "You can install dbt Core using a few different tested methods."
pagination_next: "docs/core/homebrew-install"
pagination_prev: null
---

[dbt Core](https://github.com/dbt-labs/dbt-core) is an open sourced project where you can develop from the command line and run your dbt project.

To use dbt Core, your workflow generally looks like:

1. **Build your dbt project in a code editor &mdash;** popular choices include VSCode and Atom.

2. **Run your project from the command line &mdash;** macOS ships with a default Terminal program, however you can also use iTerm or the command line prompt within a code editor to execute dbt commands.

:::info How we set up our computers for working on dbt projects

We've written a [guide](https://discourse.getdbt.com/t/how-we-set-up-our-computers-for-working-on-dbt-projects/243) for our recommended setup when running dbt projects using dbt Core.

:::

If you're using the command line, we recommend learning some basics of your terminal to help you work more effectively. In particular, it's important to understand `cd`, `ls` and `pwd` to be able to navigate through the directory structure of your computer easily.

## Install dbt Core

You can install dbt Core on the command line by using one of these methods:

- [Use pip to install dbt](/docs/core/pip-install) (recommended)
- [Use Homebrew to install dbt](/docs/core/homebrew-install)
- [Use a Docker image to install dbt](/docs/core/docker-install)
- [Install dbt from source](/docs/core/source-install)

:::tip Pro tip: Using the --help flag

Most command-line tools, including dbt, have a `--help` flag that you can use to show available commands and arguments. For example, you can use the `--help` flag with dbt in two ways:<br /><br />
&mdash; `dbt --help`: Lists the commands available for dbt<br />
&mdash; `dbt run --help`: Lists the flags available for the `run` command

:::
- You can also develop locally using the [dbt Cloud CLI](/docs/cloud/cloud-cli-installation). The dbt Cloud CLI and dbt Core are both command line tools that let you run dbt commands. The key distinction is the dbt Cloud CLI is tailored for dbt Cloud's infrastructure and integrates with all its [features](/docs/cloud/about-cloud/dbt-cloud-features).

## Upgrading dbt Core

Expand All @@ -32,3 +42,11 @@ dbt provides a number of resources for understanding [general best practices](/b
## About dbt data platforms and adapters

dbt works with a number of different data platforms (databases, query engines, and other SQL-speaking technologies). It does this by using a dedicated _adapter_ for each. When you install dbt Core, you'll also want to install the specific adapter for your database. For more details, see [Supported Data Platforms](/docs/supported-data-platforms).

:::tip Pro tip: Using the --help flag

Most command-line tools, including dbt, have a `--help` flag that you can use to show available commands and arguments. For example, you can use the `--help` flag with dbt in two ways:<br /><br />
&mdash; `dbt --help`: Lists the commands available for dbt<br />
&mdash; `dbt run --help`: Lists the flags available for the `run` command

:::
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ import UpgradeMove from '/snippets/_upgrade-move.md';
## Resources

- [Changelog](https://github.com/dbt-labs/dbt-core/blob/8aaed0e29f9560bc53d9d3e88325a9597318e375/CHANGELOG.md)
- [CLI Installation guide](/docs/core/installation)
- [CLI Installation guide](/docs/core/installation-overview)
- [Cloud upgrade guide](/docs/dbt-versions/upgrade-core-in-cloud)
- [Release schedule](https://github.com/dbt-labs/dbt-core/issues/8260)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ dbt Core v1.6 has three significant areas of focus:
## Resources

- [Changelog](https://github.com/dbt-labs/dbt-core/blob/1.6.latest/CHANGELOG.md)
- [CLI Installation guide](/docs/core/installation)
- [CLI Installation guide](/docs/core/installation-overview
- [Cloud upgrade guide](/docs/dbt-versions/upgrade-core-in-cloud)
- [Release schedule](https://github.com/dbt-labs/dbt-core/issues/7481)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ dbt Core v1.5 is a feature release, with two significant additions:
## Resources

- [Changelog](https://github.com/dbt-labs/dbt-core/blob/1.5.latest/CHANGELOG.md)
- [CLI Installation guide](/docs/core/installation)
- [CLI Installation guide](/docs/core/installation-overview)
- [Cloud upgrade guide](/docs/dbt-versions/upgrade-core-in-cloud)
- [Release schedule](https://github.com/dbt-labs/dbt-core/issues/6715)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ import UpgradeMove from '/snippets/_upgrade-move.md';
### Resources

- [Changelog](https://github.com/dbt-labs/dbt-core/blob/1.4.latest/CHANGELOG.md)
- [CLI Installation guide](/docs/core/installation)
- [CLI Installation guide](/docs/core/installation-overview)
- [Cloud upgrade guide](/docs/dbt-versions/upgrade-core-in-cloud)

**Final release:** January 25, 2023
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ import UpgradeMove from '/snippets/_upgrade-move.md';
### Resources

- [Changelog](https://github.com/dbt-labs/dbt-core/blob/1.3.latest/CHANGELOG.md)
- [CLI Installation guide](/docs/core/installation)
- [CLI Installation guide](/docs/core/installation-overview)
- [Cloud upgrade guide](/docs/dbt-versions/upgrade-core-in-cloud)

## What to know before upgrading
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ import UpgradeMove from '/snippets/_upgrade-move.md';
### Resources

- [Changelog](https://github.com/dbt-labs/dbt-core/blob/1.2.latest/CHANGELOG.md)
- [CLI Installation guide](/docs/core/installation)
- [CLI Installation guide](/docs/core/installation-overview)
- [Cloud upgrade guide](/docs/dbt-versions/upgrade-core-in-cloud)

## What to know before upgrading
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ import UpgradeMove from '/snippets/_upgrade-move.md';
### Resources

- [Changelog](https://github.com/dbt-labs/dbt-core/blob/1.1.latest/CHANGELOG.md)
- [CLI Installation guide](/docs/core/installation)
- [CLI Installation guide](/docs/core/installation-overview)
- [Cloud upgrade guide](/docs/dbt-versions/upgrade-core-in-cloud)

## What to know before upgrading
Expand Down
Loading
Loading