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

Update Docusaurus Version #862

Merged
merged 5 commits into from
Oct 19, 2021
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ The type of license a user is assigned controls which capabilities of dbt
Cloud the user is permitted to access. Users with a Developer license can be
granted access to the Deployment and [Development](the-dbt-ide) functionality
in dbt Cloud, whereas users with Read Only licenses are intended to view the
[artifacts](using-dbt-cloud/artifacts.md) created in a dbt Cloud account.
[artifacts](docs/dbt-cloud/using-dbt-cloud/artifacts) created in a dbt Cloud account.

| Functionality | Developer User | Read Only Users |
| ------------- | -------------- | --------------- |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Below we try to help you answer the question of whether a known breaking change

:::info An Important Note on Packages

If you use any packages from [dbt Hub]([https://hub.getdbt.com/](https://hub.getdbt.com/)), make sure you also upgrade to a version of the package that supports the dbt version you intend to upgrade to. You can see which dbt versions a package supports by checking on the `require-dbt-version:` in the package's dbt_project.yml file on GitHub.
If you use any packages from [dbt Hub](https://hub.getdbt.com/), make sure you also upgrade to a version of the package that supports the dbt version you intend to upgrade to. You can see which dbt versions a package supports by checking on the `require-dbt-version:` in the package's dbt_project.yml file on GitHub.

As an example, dbt-utils version 0.7.1 supports dbt v0.20 and v0.21, as described in its [dbt_project.yml](https://github.com/dbt-labs/dbt-utils/blob/0.7.1/dbt_project.yml).

Expand Down
2 changes: 1 addition & 1 deletion website/docs/docs/dbt-cloud/cloud-quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Let's get started!

## Create a connection

dbt Cloud uses this connection to _connect_ to your database when running jobs and transformation queries. Depending on the type of data warehouse you're using, you'll need to supply [different configuration parameters](connecting-your-database.md). dbt Cloud natively supports connections to Snowflake, BigQuery, Redshift, Apache Spark, Databricks, and Postgres.
dbt Cloud uses this connection to _connect_ to your database when running jobs and transformation queries. Depending on the type of data warehouse you're using, you'll need to supply [different configuration parameters](docs/dbt-cloud/cloud-configuring-dbt-cloud/connecting-your-database). dbt Cloud natively supports connections to Snowflake, BigQuery, Redshift, Apache Spark, Databricks, and Postgres.

After picking a data warehouse type, a form will be generated where you can populate your warehouse's credentials. These credentials are encrypted at rest, and dbt Cloud never stores credentials in plaintext.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ can override schema test definitions
- [list (ls)](commands/list)
- [defer](defer)
- [adapter.dispatch](adapter#dispatch)
- [`asset-paths` config](asset-paths) (also updated [dbt_project.yml](dbt_project.yml.md) and [description](description))
- [`asset-paths` config](asset-paths) (also updated [dbt_project.yml](reference/dbt_project.yml) and [description](description))
- [flag for colorized logs](run#enable-or-disable-colorized-logs)
- [`full_refresh` config](full_refresh)

Expand Down
2 changes: 1 addition & 1 deletion website/docs/learn/3-build-your-first-models.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ id: build-your-first-models
description: With our starter project setup, it's time to get to the fun part — building models!
---

With our starter project setup, it's time to get to the fun part — building [models](/docs/building-models)! We're going to take the query from the [Setting up](/learn/setting-up) instructions, and turn it into a model in our dbt project.
With our starter project setup, it's time to get to the fun part — building [models](/docs/building-a-dbt-project/building-models)! We're going to take the query from the [Setting up](/learn/setting-up) instructions, and turn it into a model in our dbt project.

## Checkout a new git branch
### dbt Cloud
Expand Down
6 changes: 3 additions & 3 deletions website/docs/learn/4-test-and-document-your-project.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: Let's test and document our models to build trust in our data.
---

## Add tests to your models
Adding [tests](/docs/testing) to a project helps validate that your models are working correctly. So let's add some tests to our project!
Adding [tests](/docs/building-a-dbt-project/tests) to a project helps validate that your models are working correctly. So let's add some tests to our project!

<CloudCore>
<LoomVideo id="86a1e7ed19084810a7903bd31ebd83e0" />
Expand Down Expand Up @@ -78,7 +78,7 @@ When you run `dbt test`, dbt iterates through your YAML files, and constructs a
<FAQ src="when-to-test" />

## Document your models
Adding [documentation](/docs/documentation) to your project allows you to describe your models in rich detail, and share that information with your team. Here, we're going to add some basic documentation to our project.
Adding [documentation](/docs/building-a-dbt-project/documentation) to your project allows you to describe your models in rich detail, and share that information with your team. Here, we're going to add some basic documentation to our project.

<CloudCore>
<LoomVideo id="f946321f692747e59bec3b726eccbfd4" />
Expand Down Expand Up @@ -153,7 +153,7 @@ Great work ⭐️! You've just built your first dbt project that's tested and do

* Write a test that fails, for example, omit one of the order statuses in the `accepted_values` list. What does a failing test look like? Can you debug the failure?
* Run the tests for one model only. If you grouped your `stg_` models into a directory, try running the tests for all the models in that directory.
* Use a [docs block](/docs/documentation#using-docs-blocks) to add a Markdown description to a model.
* Use a [docs block](/docs/building-a-dbt-project/documentation#using-docs-blocks) to add a Markdown description to a model.

## Commit your changes
First off, we need to commit the changes we made to our project so that our repository has our latest code.
Expand Down
2 changes: 1 addition & 1 deletion website/docs/reference/project-configs/profile.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ The profile your dbt project should use to connect to your data warehouse.
* If you are developing locally: This configuration is required, unless a command-line option (i.e. `--profile`) is supplied.

## Related guides
* [Connecting to your warehouse](docs/dbt-cli/configure-your-profile.md)
* [Connecting to your warehouse](dbt-cli/configure-your-profile)

## Recommendation
Often an organization has only one data warehouse, so it is sensible to use your organization's name as a profile name, in `snake_case`. For example:
Expand Down
2 changes: 1 addition & 1 deletion website/docs/reference/resource-configs/alias.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ This is a work in progress document. While this configuration applies to multipl

## Definition

Optionally specify a custom alias for a [model](docs/docs/building-a-dbt-project/building-models.md) or [seed](docs/docs/building-a-dbt-project/seeds.md).
Optionally specify a custom alias for a [model](docs/building-a-dbt-project/building-models) or [seed](docs/building-a-dbt-project/seeds).

When dbt creates a relation (table/view) in a database, it creates it as: `{{ database }}.{{ schema }}.{{ identifier }}`, e.g. `analytics.finance.payments`

Expand Down
2 changes: 1 addition & 1 deletion website/docs/reference/resource-configs/database.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ This is a work in progress document. While this configuration applies to multipl

## Definition

Optionally specify a custom database for a [model](docs/docs/building-a-dbt-project/building-models.md) or [seed](docs/docs/building-a-dbt-project/seeds.md). (To specify a database for a [snapshot](snapshots), use the [`target_database` config](target_database)).
Optionally specify a custom database for a [model](docs/building-a-dbt-project/building-models) or [seed](docs/building-a-dbt-project/seeds). (To specify a database for a [snapshot](snapshots), use the [`target_database` config](target_database)).

When dbt creates a relation (table/view) in a database, it creates it as: `{{ database }}.{{ schema }}.{{ identifier }}`, e.g. `analytics.finance.payments`

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@ Pre- and post-hooks can also call macros that return SQL statements.

<Changelog>

* `v0.12.2`: The `post_hook` alias for config blocks was introduced. Prior to this, users needed to use the [alternative config syntax]() to apply pre- and post-hooks.
* `v0.12.2`: The `post_hook` alias for config blocks was introduced. Prior to this, users needed to use the alternative config syntax to apply pre- and post-hooks.

</Changelog>

Expand Down
4 changes: 2 additions & 2 deletions website/docs/reference/resource-configs/schema.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,15 @@ This is a work in progress document. While this configuration applies to multipl
:::

## Definition
Optionally specify a custom schema for a [model](docs/docs/building-a-dbt-project/building-models.md) or [seed](docs/docs/building-a-dbt-project/seeds.md). (To specify a schema for a [snapshot](snapshots), use the [`target_schema` config](target_schema)).
Optionally specify a custom schema for a [model](docs/building-a-dbt-project/building-models) or [seed](docs/building-a-dbt-project/seeds). (To specify a schema for a [snapshot](snapshots), use the [`target_schema` config](target_schema)).

When dbt creates a relation (table/view) in a database, it creates it as: `{{ database }}.{{ schema }}.{{ identifier }}`, e.g. `analytics.finance.payments`

The standard behavior of dbt is:
* If a custom schema is _not_ specified, the schema of the relation is the target schema (`{{ target.schema }}`).
* If a custom schema is specified, by default, the schema of the relation is `{{ target.schema }}_{{ schema }}`.

To learn more about changing the way that dbt generates a relation's `schema`, read [Using Custom Schemas](docs/docs/building-a-dbt-project/building-models/using-custom-schemas.md)
To learn more about changing the way that dbt generates a relation's `schema`, read [Using Custom Schemas](docs/building-a-dbt-project/building-models/using-custom-schemas)

## Usage

Expand Down
6 changes: 3 additions & 3 deletions website/docs/tutorial/4-test-and-document-your-project.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: Let's test and document our models to build trust in our data.
---

## Add tests to your models
Adding [tests](/docs/testing) to a project helps validate that your models are working correctly. So let's add some tests to our project!
Adding [tests](/docs/building-a-dbt-project/tests) to a project helps validate that your models are working correctly. So let's add some tests to our project!

<CloudCore>
<LoomVideo id="86a1e7ed19084810a7903bd31ebd83e0" />
Expand Down Expand Up @@ -80,7 +80,7 @@ When you run `dbt test`, dbt iterates through your YAML files, and constructs a
<FAQ src="when-to-test" />

## Document your models
Adding [documentation](/docs/documentation) to your project allows you to describe your models in rich detail, and share that information with your team. Here, we're going to add some basic documentation to our project.
Adding [documentation](/docs/building-a-dbt-project/documentation) to your project allows you to describe your models in rich detail, and share that information with your team. Here, we're going to add some basic documentation to our project.

<CloudCore>
<LoomVideo id="f946321f692747e59bec3b726eccbfd4" />
Expand Down Expand Up @@ -157,4 +157,4 @@ Great work ⭐️! You've just built your first dbt project that's tested and do

* Write a test that fails, for example, omit one of the order statuses in the `accepted_values` list. What does a failing test look like? Can you debug the failure?
* Run the tests for one model only. If you grouped your `stg_` models into a directory, try running the tests for all the models in that directory.
* Use a [docs block](/docs/documentation#using-docs-blocks) to add a Markdown description to a model.
* Use a [docs block](/docs/building-a-dbt-project/documentation#using-docs-blocks) to add a Markdown description to a model.
4 changes: 2 additions & 2 deletions website/docs/tutorial/5-deploy-your-project.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,11 +84,11 @@ Here's a few suggestions to keep learning:
Ready to get started with your own project? We recommend doing the tutorial a second time to create a new project. You should use your own warehouse, along with a query that you frequently run, to build your first models!

### Learn some best practices
Now that you've got a working dbt project, read more about some of our [best practices](/docs/best-practices), or go back this tutorial and read some of the FAQs.
Now that you've got a working dbt project, read more about some of our [best practices](/docs/guides/best-practices), or go back this tutorial and read some of the FAQs.

### Keep building this project
Here's some suggested exercises to level-up your dbt skills:
* Try turning your raw data references (e.g. `` `dbt-tutorial`.jaffle_shop.orders``) into [sources](/docs/using-sources).
* Try turning your raw data references (e.g. `` `dbt-tutorial`.jaffle_shop.orders``) into [sources](/docs/building-a-dbt-project/using-sources).
* Build a new models for `orders`, that uses the `payments` table to calculate the total order amount.
* Reorganize your project into our [recommended structure](https://discourse.getdbt.com/t/how-we-structure-our-dbt-projects/355)
* Use some Jinja in your project — check out the [Jinja tutorial](/tutorial/using-jinja).
14 changes: 8 additions & 6 deletions website/docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -70,22 +70,21 @@ module.exports = {
tagline: 'End user documentation, guides and technical reference for dbt (data build tool)',
title: 'dbt Docs',
url: SITE_URL,
onBrokenLinks: 'warn',

themeConfig: {
disableDarkMode: true,
sidebarCollapsible: true,
image: '/img/avatar.png',

colorMode: {
disableSwitch: true
},
announcementBar: WARNING_BANNER,

algolia: {
apiKey: ALGOLIA_API_KEY,
//debug: true,
indexName: ALGOLIA_INDEX_NAME,
algoliaOptions: {
},
},

prism: {
theme: (() => {
var theme = require('prism-react-renderer/themes/nightOwl');
Expand All @@ -111,7 +110,7 @@ module.exports = {
src: '/img/dbt-logo-light.svg',
alt: 'dbt Logo',
},
links: [
items: [
{
to: '/docs/introduction',
label: 'Docs',
Expand Down Expand Up @@ -199,6 +198,8 @@ module.exports = {
editUrl: 'https://github.com/fishtown-analytics/docs.getdbt.com/edit/' + GIT_BRANCH + '/website/',
showLastUpdateTime: false,
//showLastUpdateAuthor: false,

sidebarCollapsible: true,
}
},
],
Expand All @@ -209,6 +210,7 @@ module.exports = {
{ metatags }
],
path.resolve('plugins/svg'),
path.resolve('plugins/customWebpackConfig'),
],
scripts: [
'https://code.jquery.com/jquery-3.4.1.min.js',
Expand Down
Loading