Skip to content

Commit

Permalink
Making breadcrumbs clickable (#3515)
Browse files Browse the repository at this point in the history
## What are you changing in this pull request and why?

Making the breadcrumb trail items in the docs pages clickable. Many of
them are now, but the categories that don't have links are static and
unable to be used for navigation.

Based on customer feedback, our readers would like to be able to click
on all items in the breadcrumb trail to make navigation through the
pages easier.

This will add links to the categories that don't have them by leveraging
existing `About...` pages or creating new ones where required. To keep a
consistent navigational experience, we will make the links available as
pages in the menu as well.

## Checklist
<!--
Uncomment if you're publishing docs for a prerelease version of dbt
(delete if not applicable):
- [ ] Add versioning components, as described in [Versioning
Docs](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/single-sourcing-content.md#versioning-entire-pages)
- [ ] Add a note to the prerelease version [Migration
Guide](https://github.com/dbt-labs/docs.getdbt.com/tree/current/website/docs/guides/migration/versions)
-->
- [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] 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):
- [ ] Add page to `website/sidebars.js`
- [ ] Provide a unique filename for the new page

Removing or renaming existing pages (delete if not applicable):
- [ ] Remove page from `website/sidebars.js`
- [ ] Add an entry `website/static/_redirects`
- [ ] [Ran link
testing](https://github.com/dbt-labs/docs.getdbt.com#running-the-cypress-tests-locally)
to update the links that point to the deleted page
  • Loading branch information
matthewshaver authored Oct 17, 2023
2 parents 5c40a44 + e88588b commit c915480
Show file tree
Hide file tree
Showing 81 changed files with 451 additions and 30 deletions.
2 changes: 2 additions & 0 deletions website/docs/docs/about-setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ title: About dbt setup
id: about-setup
description: "About setup of dbt Core and Cloud"
sidebar_label: "About dbt setup"
pagination_next: "docs/environments-in-dbt"
pagination_prev: null
---

dbt compiles and runs your analytics code against your data platform, enabling you and your team to collaborate on a single source of truth for metrics, insights, and business definitions. There are two options for deploying dbt:
Expand Down
2 changes: 2 additions & 0 deletions website/docs/docs/build/about-metricflow.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ id: about-metricflow
description: "Learn more about MetricFlow and its key concepts"
sidebar_label: About MetricFlow
tags: [Metrics, Semantic Layer]
pagination_next: "docs/build/join-logic"
pagination_prev: null
---

This guide introduces MetricFlow's fundamental ideas for new users. MetricFlow, which powers the dbt Semantic Layer, helps you define and manage the logic for your company's metrics. It's an opinionated set of abstractions and helps data consumers retrieve metric datasets from a data platform quickly and efficiently.
Expand Down
1 change: 1 addition & 0 deletions website/docs/docs/build/analyses.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: "Analyses"
description: "Read this tutorial to learn how to use custom analyses when building in dbt."
id: "analyses"
pagination_next: null
---

## Overview
Expand Down
2 changes: 2 additions & 0 deletions website/docs/docs/build/build-metrics-intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ description: "Learn about MetricFlow and build your metrics with semantic models
sidebar_label: Build your metrics
tags: [Metrics, Semantic Layer, Governance]
hide_table_of_contents: true
pagination_next: "docs/build/sl-getting-started"
pagination_prev: null
---

Use MetricFlow in dbt to centrally define your metrics. As a key component of the [dbt Semantic Layer](/docs/use-dbt-semantic-layer/dbt-sl), MetricFlow is responsible for SQL query construction and defining specifications for dbt semantic models and metrics.
Expand Down
1 change: 1 addition & 0 deletions website/docs/docs/build/custom-schemas.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: "Custom schemas"
id: "custom-schemas"
pagination_next: "docs/build/custom-databases"
---

By default, all dbt models are built in the schema specified in your target. In dbt projects with lots of models, it may be useful to instead build some models in schemas other than your target schema – this can help logically group models together.
Expand Down
2 changes: 1 addition & 1 deletion website/docs/docs/build/custom-target-names.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: "Custom target names"
id: "custom-target-names"
description: "You can define a custom target name for any dbt Cloud job to correspond to settings in your dbt project."

pagination_next: null
---

## dbt Cloud Scheduler
Expand Down
38 changes: 38 additions & 0 deletions website/docs/docs/build/enhance-your-code.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
---
title: "Enhance your code"
description: "Learn how you can enhance your code"
pagination_next: "docs/build/project-variables"
pagination_prev: null
---

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

<Card
title="Project variables"
body="Learn how to use project variables to provide data to models for compilation."
link="/docs/build/project-variables"
icon="dbt-bit"/>

<Card
title="Environment variables"
body="Learn how you can use environment variables to customize the behavior of a dbt project."
link="/docs/build/environment-variables"
icon="dbt-bit"/>

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

<Card
title="Packages"
body="Learn how you can leverage code reuse through packages (libraries)."
link="/docs/build/packages"
icon="dbt-bit"/>

<Card
title="Hooks and operations"
body="Learn how to use hooks to trigger actions and operations to invoke macros."
link="/docs/build/hooks-operations"
icon="dbt-bit"/>

</div>
23 changes: 23 additions & 0 deletions website/docs/docs/build/enhance-your-models.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
title: "Enhance your models"
description: "Learn how you can enhance your models"
pagination_next: "docs/build/materializations"
pagination_prev: null
---

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

<Card
title="Materializations"
body="Learn how to use materializations to make dbt models persist in a data platform."
link="/docs/build/materializations"
icon="dbt-bit"/>

<Card
title="Incremental models"
body="Learn how to use incremental models so you can limit the amount of data that needs to be transformed."
link="/docs/build/incremental-models"
icon="dbt-bit"/>

</div>
<br />
1 change: 1 addition & 0 deletions website/docs/docs/build/materializations.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: "Materializations"
description: "Read this tutorial to learn how to use materializations when building in dbt."
id: "materializations"
pagination_next: "docs/build/incremental-models"
---

## Overview
Expand Down
1 change: 1 addition & 0 deletions website/docs/docs/build/metrics-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ id: metrics-overview
description: "Metrics can be defined in the same or separate YAML files from semantic models within the same dbt project repo."
sidebar_label: "Creating metrics"
tags: [Metrics, Semantic Layer]
pagination_next: "docs/build/cumulative"
---

Once you've created your semantic models, it's time to start adding metrics! Metrics can be defined in the same YAML files as your semantic models, or split into separate YAML files into any other subdirectories (provided that these subdirectories are also within the same dbt project repo)
Expand Down
2 changes: 2 additions & 0 deletions website/docs/docs/build/models.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
title: "About dbt models"
description: "Read this tutorial to learn how to use models when building in dbt."
id: "models"
pagination_next: "docs/build/sql-models"
pagination_prev: null
---

## Overview
Expand Down
38 changes: 38 additions & 0 deletions website/docs/docs/build/organize-your-outputs.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
---
title: "Organize your outputs"
description: "Learn how you can organize your outputs"
pagination_next: "docs/build/custom-schemas"
pagination_prev: null
---

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

<Card
title="Custom schemas"
body="Learn how to use the <code>schema</code> configuration key to specify a custom schema."
link="/docs/build/custom-schemas"
icon="dbt-bit"/>

<Card
title="Custom databases"
body="Learn how to use the <code>database</code> configuration key to specify a custom database."
link="/docs/build/custom-databases"
icon="dbt-bit"/>

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

<Card
title="Custom aliases"
body="Learn how to use the <code>alias</code> model configuration to change the name of a model's identifier in the database."
link="/docs/build/custom-aliases"
icon="dbt-bit"/>

<Card
title="Custom target names"
body="Learn how to define a custom target name for a dbt Cloud job."
link="/docs/build/custom-target-names"
icon="dbt-bit"/>

</div>
1 change: 1 addition & 0 deletions website/docs/docs/build/project-variables.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: "Project variables"
id: "project-variables"
pagination_next: "docs/build/environment-variables"
---

dbt provides a mechanism, [variables](/reference/dbt-jinja-functions/var), to provide data to models for
Expand Down
2 changes: 2 additions & 0 deletions website/docs/docs/build/projects.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
title: "About dbt projects"
id: "projects"
pagination_next: null
pagination_prev: null
---

A dbt project informs dbt about the context of your project and how to transform your data (build your data sets). By design, dbt enforces the top-level structure of a dbt project such as the `dbt_project.yml` file, the `models` directory, the `snapshots` directory, and so on. Within the directories of the top-level, you can organize your project in any way that meets the needs of your organization and data pipeline.
Expand Down
1 change: 1 addition & 0 deletions website/docs/docs/build/semantic-models.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ keywords:
- dbt metrics layer
sidebar_label: Semantic models
tags: [Metrics, Semantic Layer]
pagination_next: "docs/build/dimensions"
---

Semantic models are the foundation for data definition in MetricFlow, which powers the dbt Semantic Layer:
Expand Down
1 change: 1 addition & 0 deletions website/docs/docs/build/simple.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ id: simple
description: "Use simple metrics to directly reference a single measure."
sidebar_label: Simple
tags: [Metrics, Semantic Layer]
pagination_next: null
---

Simple metrics are metrics that directly reference a single measure, without any additional measures involved. They are aggregations over a column in your data platform and can be filtered by one or multiple dimensions.
Expand Down
2 changes: 2 additions & 0 deletions website/docs/docs/cloud/about-cloud-setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ title: About dbt Cloud setup
id: about-cloud-setup
description: "Configuration settings for dbt Cloud."
sidebar_label: "About dbt Cloud setup"
pagination_next: "docs/dbt-cloud-environments"
pagination_prev: null
---

dbt Cloud is the fastest and most reliable way to deploy your dbt jobs. It contains a myriad of settings that can be configured by admins, from the necessities (data platform integration) to security enhancements (SSO) and quality-of-life features (RBAC). This portion of our documentation will take you through the various settings found by clicking on the gear icon in the dbt Cloud UI, including:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ id: "dbt-cloud-features"
sidebar_label: "dbt Cloud features"
description: "Explore dbt Cloud's features and learn why dbt Cloud is the fastest way to deploy dbt"
hide_table_of_contents: true
pagination_next: "docs/cloud/about-cloud/architecture"
pagination_prev: null
---

dbt Cloud is the fastest and most reliable way to deploy dbt. Develop, test, schedule, document, and investigate data models all in one browser-based UI. In addition to providing a hosted architecture for running dbt across your organization, dbt Cloud comes equipped with turnkey support for scheduling jobs, CI/CD, hosting documentation, monitoring & alerting, and an integrated development environment (IDE).
Expand Down
1 change: 1 addition & 0 deletions website/docs/docs/cloud/about-cloud/browsers.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: "Supported browsers"
id: "browsers"
description: "dbt Cloud supports the latest browsers like Chrome and Firefox."
pagination_next: null
---

To have the best experience with dbt Cloud, we recommend using the latest versions of the following browsers:
Expand Down
2 changes: 2 additions & 0 deletions website/docs/docs/cloud/billing.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ title: "Billing"
id: billing
description: "dbt Cloud billing information."
sidebar_label: Billing
pagination_next: null
pagination_prev: null
---

dbt Cloud offers a variety of [plans and pricing](https://www.getdbt.com/pricing/) to fit your organization’s needs. With flexible billing options that appeal to large enterprises and small businesses and [server availability](/docs/cloud/about-cloud/regions-ip-addresses) worldwide, dbt Cloud is the fastest and easiest way to begin transforming your data.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ title: "About data platform connections"
id: about-connections
description: "Information about data platform connections"
sidebar_label: "About data platform connections"
pagination_next: "docs/cloud/connect-data-platform/connect-starburst-trino"
pagination_prev: null
---
dbt Cloud can connect with a variety of data platform providers including:
- [Amazon Redshift](/docs/cloud/connect-data-platform/connect-redshift-postgresql-alloydb)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ title: "Connect Apache Spark"
id: connect-apache-spark
description: "Setup instructions for connecting Apache Spark to dbt Cloud"
sidebar_label: "Connect Apache Spark"
pagination_next: null
---

<Snippet path="dbt-databricks-for-databricks" />
Expand Down
37 changes: 37 additions & 0 deletions website/docs/docs/cloud/dbt-cloud-ide/dbt-cloud-ide.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
---
title: "dbt Cloud IDE"
description: "Learn how to configure Git in dbt Cloud"
pagination_next: "docs/cloud/dbt-cloud-ide/develop-in-the-cloud"
pagination_prev: null
---

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

<Card
title="Develop in the IDE"
body="Learn about the different features in the IDE and how to develop your dbt projects with them."
link="/docs/cloud/git/import-a-project-by-git-url"
icon="dbt-bit"/>

<Card
title="IDE user interface"
body="Learn how you can build, test, run, and version control dbt projects in the IDE."
link="/docs/cloud/dbt-cloud-ide/develop-in-the-cloud"
icon="dbt-bit"/>

</div>
<br />
<div className="grid--2-col">
<Card
title="Lint and format your code"
body="Learn about how to lint and format your code with SQLFluff, Prettier, and more. "
link="/docs/cloud/dbt-cloud-ide/lint-format"
icon="dbt-bit"/>

<Card
title="dbt Cloud tips"
body="Learn about tips and tricks (like keyboard shortcuts) that you can use in dbt Cloud."
link="/docs/cloud/dbt-cloud-ide/dbt-cloud-tips"
icon="dbt-bit"/>

</div>
1 change: 1 addition & 0 deletions website/docs/docs/cloud/dbt-cloud-ide/dbt-cloud-tips.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ title: "Tips and tricks"
id: dbt-cloud-tips
description: "Check out any dbt Cloud and IDE-related tips."
sidebar_label: "Tips and tricks"
pagination_next: null
---

# dbt Cloud tips
Expand Down
2 changes: 2 additions & 0 deletions website/docs/docs/cloud/dbt-cloud-ide/develop-in-the-cloud.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ id: develop-in-the-cloud
description: "Develop, test, run, and build in the Cloud IDE. With the Cloud IDE, you can compile dbt code into SQL and run it against your database directly"
sidebar_label: Develop in the IDE
tags: [IDE]
pagination_next: "docs/cloud/dbt-cloud-ide/ide-user-interface"
pagination_prev: null
---

The dbt Cloud integrated development environment (IDE) is a single interface for building, testing, running, and version-controlling dbt projects from your browser. With the Cloud IDE, you can compile dbt code into SQL and run it against your database directly.
Expand Down
1 change: 1 addition & 0 deletions website/docs/docs/cloud/git/authenticate-azure.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ title: "Authenticate with Azure DevOps"
id: "authenticate-azure"
description: "dbt Cloud developers need to authenticate with Azure DevOps."
sidebar_label: "Authenticate with Azure DevOps"
pagination_next: null
---


Expand Down
1 change: 1 addition & 0 deletions website/docs/docs/cloud/git/connect-azure-devops.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: "Connect to Azure DevOps"
id: "connect-azure-devops"
pagination_next: "docs/cloud/git/setup-azure"
---

<Snippet path="available-enterprise-tier-only" />
Expand Down
37 changes: 37 additions & 0 deletions website/docs/docs/cloud/git/git-configuration-in-dbt-cloud.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
---
title: "Git configuration in dbt Cloud"
description: "Learn about the Git providers supported in dbt Cloud"
pagination_next: "docs/cloud/git/import-a-project-by-git-url"
pagination_prev: null
---

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

<Card
title="Import a project by git URL"
body="Learn how to import a project by using a git URL."
link="/docs/cloud/git/import-a-project-by-git-url"
icon="dbt-bit"/>

<Card
title="Connect to GitHub"
body="Learn how to connect to GitHub."
link="/docs/cloud/git/connect-github"
icon="dbt-bit"/>

</div>
<br />
<div className="grid--2-col">
<Card
title="Connect to GitLab"
body="Learn how to connect to GitLab."
link="/docs/cloud/git/connect-gitlab"
icon="dbt-bit"/>

<Card
title="Connect to Azure DevOps"
body="Learn how to connect to Azure DevOps."
link="/docs/cloud/git/connect-azure-devops"
icon="dbt-bit"/>

</div>
2 changes: 2 additions & 0 deletions website/docs/docs/cloud/git/import-a-project-by-git-url.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
title: "Import a project by git URL"
id: "import-a-project-by-git-url"
pagination_next: "docs/cloud/git/connect-github"
pagination_prev: null
---

In dbt Cloud, you can import a git repository from any valid git URL that points to a dbt project. There are some important considerations to keep in mind when doing this.
Expand Down
2 changes: 2 additions & 0 deletions website/docs/docs/cloud/manage-access/about-access.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
title: "About user access in dbt Cloud"
description: "Learn how dbt Cloud administrators can use dbt Cloud's permissioning model to control user-level access in a dbt Cloud account."
id: "about-user-access"
pagination_next: "docs/cloud/manage-access/seats-and-users"
pagination_prev: null
---

:::info "User access" is not "Model access"
Expand Down
Loading

0 comments on commit c915480

Please sign in to comment.