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

Docusaurus v3 #5685

Merged
merged 64 commits into from
Aug 7, 2024
Merged
Show file tree
Hide file tree
Changes from 57 commits
Commits
Show all changes
64 commits
Select commit Hold shift + click to select a range
b3dde0d
fix compile issues in contributing files
JKarlavige Jun 13, 2024
667b7a1
adjust contributing files
JKarlavige Jun 13, 2024
53b6623
save edits
JKarlavige Jun 13, 2024
cd59d71
fix blog formatting
JKarlavige Jun 13, 2024
dbe518c
continue adjusting files to resolve mdx errors
JKarlavige Jun 13, 2024
76eec35
next batch
JKarlavige Jun 13, 2024
ddb914e
next batch
JKarlavige Jun 13, 2024
ff620fa
next batch
JKarlavige Jun 13, 2024
c24f0e6
next batch
JKarlavige Jun 13, 2024
236082f
fix final formatting issues
JKarlavige Jun 13, 2024
796374d
upgrade packages
JKarlavige Jun 14, 2024
2f2105f
adjust docusaurus config imports
JKarlavige Jun 14, 2024
15077dc
merge mdx formatting issues branch
JKarlavige Jun 14, 2024
e521691
adjust blog data for homepage
JKarlavige Jun 14, 2024
29c5f7f
remove custom code block
JKarlavige Jun 17, 2024
848c788
remove FAQList component
JKarlavige Jun 17, 2024
aafbbf8
swizzle latest DocCard component
JKarlavige Jun 20, 2024
1ba9277
apply customizations to DocCard component
JKarlavige Jun 21, 2024
3f99fcc
adjust details mdx component
JKarlavige Jun 24, 2024
ad98982
remove MSCallout component which does not exist
JKarlavige Jun 24, 2024
1a36ea9
add line break before snippet import
JKarlavige Jun 24, 2024
50bcc72
Merge branch 'current' into docusaurus-v3
JKarlavige Jun 25, 2024
feb419b
fix markdown links
JKarlavige Jun 25, 2024
e0736f2
begin refactoring FAQ component
JKarlavige Jun 25, 2024
bbd417c
update mailto links
JKarlavige Jun 25, 2024
feed647
continue fixing links
JKarlavige Jun 25, 2024
4b4c41a
merge current
JKarlavige Jul 18, 2024
177f4fd
adjust nested list
JKarlavige Jul 18, 2024
21d8b8e
resolve broken links - group 1
JKarlavige Jul 18, 2024
a8db5b0
resolve broken links - group 2
JKarlavige Jul 19, 2024
1577eeb
resolve broken links - upgrade cloud version page
JKarlavige Jul 19, 2024
6d45d17
resolve broken links - group 3
JKarlavige Jul 19, 2024
a85a8a1
adjust stoplight-custom css
JKarlavige Jul 19, 2024
44d7414
remove markdown links in code blocks section from styles page
JKarlavige Jul 19, 2024
457f09e
remove node version from package.json to use the node version set in …
JKarlavige Jul 19, 2024
26a785e
save progress on faqs md import fix
JKarlavige Jul 19, 2024
7d5cc24
merge current and resolve conflict
JKarlavige Jul 19, 2024
526f9d7
merge current and resolve conflict
JKarlavige Aug 1, 2024
4641448
save progress for faq component (not working)
JKarlavige Aug 1, 2024
bf8494c
remove test import
JKarlavige Aug 1, 2024
e6d3b8f
fix faq file import
JKarlavige Aug 1, 2024
cb81d8f
fix faqs causing build errors
JKarlavige Aug 1, 2024
508bb54
Merge branch 'current' into docusaurus-v3
JKarlavige Aug 1, 2024
e6cb487
Merge branch 'current' into docusaurus-v3
mirnawong1 Aug 2, 2024
c6f1b61
fix community adapters table
JKarlavige Aug 2, 2024
056ae21
fix measures table
JKarlavige Aug 2, 2024
30e709e
fix sl architecture table
JKarlavige Aug 2, 2024
ad7d01a
fix core versions table
JKarlavige Aug 2, 2024
7af5289
remove old DocPage swizzled component, swizzle new DocRoot component …
JKarlavige Aug 2, 2024
ccd77f8
fix asterisk on release notes page
JKarlavige Aug 2, 2024
59b026d
update detailsToggle component to be capital-case
JKarlavige Aug 2, 2024
ab8c7ed
update all detailsToggle component usage
JKarlavige Aug 2, 2024
c93cc51
update details toggle component name
JKarlavige Aug 2, 2024
cf889f6
sanitize version param
JKarlavige Aug 2, 2024
b4ccbcf
sanitize version banner html
JKarlavige Aug 2, 2024
5b60a8e
re-swizzle CodeBlock theme component
JKarlavige Aug 2, 2024
909a3d6
bring back markdown link customization for code blocks
JKarlavige Aug 2, 2024
d903a50
Merge branch 'current' into docusaurus-v3
JKarlavige Aug 6, 2024
1a77b69
adjust blog index h2 font size
JKarlavige Aug 6, 2024
7212645
fix date not showing for blog post cards
JKarlavige Aug 6, 2024
518bede
Merge branch 'current' into docusaurus-v3
mirnawong1 Aug 6, 2024
f817e8b
Merge branch 'current' into docusaurus-v3
JKarlavige Aug 7, 2024
22160ee
Merge branch 'current' into docusaurus-v3
JKarlavige Aug 7, 2024
5607379
resolve formatting errors
JKarlavige Aug 7, 2024
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
2 changes: 1 addition & 1 deletion License.md
Original file line number Diff line number Diff line change
Expand Up @@ -186,7 +186,7 @@
same "printed page" as the copyright notice for easier
identification within third-party archives.

Copyright {yyyy} {name of copyright owner}
Copyright \{yyyy\} \{name of copyright owner\}

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
Expand Down
20 changes: 10 additions & 10 deletions contributing/adding-page-components.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,20 +4,20 @@ You can use the following components to provide code snippets for each supported

Identify code by labeling with the warehouse names:

```js
```code
<WHCode>

<div warehouse="warehouse#1">

```sql
```
select * from `dbt-tutorial.jaffle_shop.customers`
```

</div>

<div warehouse="warehouse#2">

```sql
```
select * from default.jaffle_shop_customers
```

Expand Down Expand Up @@ -45,11 +45,11 @@ Identify code and code files by labeling with the component they are describing:

<File name='models/<modelname>.sql'>

```sql
```

{{ config(
\{\{ config(

) }}
) \}\}

select ...

Expand All @@ -60,9 +60,9 @@ Identify code and code files by labeling with the component they are describing:

<File name='dbt_project.yml'>

```yml
```
models:
[<resource-path>](/reference/resource-configs/resource-path):
[resource-path](/reference/resource-configs/resource-path):


```
Expand All @@ -75,9 +75,9 @@ Identify code and code files by labeling with the component they are describing:

<File name='dbt_project.yml'>

```yml
```
sources:
[<resource-path>](/reference/resource-configs/resource-path):
[resource-path](/reference/resource-configs/resource-path):


```
Expand Down
12 changes: 6 additions & 6 deletions contributing/content-style-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -359,10 +359,10 @@ There won't be many instances where you need to display 4 or 5 cards on the docs

Otherwise, the text will appear squished and provide users with a bad experience.

- `<divclassName="grid--2-col">`: creates 2 column cards
- `<divclassName="grid--3-col">`: creates 3 columns cards
- `<divclassName="grid--4-col">`: creates 4 columns cards (use sparingly)
- `<divclassName="grid--5-col">`: creates 5 columns cards (use sparingly)
- `<div className="grid--2-col">`: creates 2 column cards
- `<div className="grid--3-col">`: creates 3 columns cards
- `<div className="grid--4-col">`: creates 4 columns cards (use sparingly)
- `<div className="grid--5-col">`: creates 5 columns cards (use sparingly)
- You can't create cards with 6 or more columns as that would provide users a poor experience.

Refer to [dbt Cloud features](/docs/cloud/about-cloud/dbt-cloud-features) and [Quickstarts](/docs/guides) as examples.
Expand Down Expand Up @@ -456,7 +456,7 @@ In general, when the spelling of English words varies by locale &mdash; use the
standardize | standardise
license | licence
color | colour
</div></b>
<b>

Avoid regional idiomatic phrases as well. For example, a common saying amongst English speakers in India is "do the needful," but this phrase may be unrecognizable to English speakers from other regions.

Expand Down Expand Up @@ -533,7 +533,7 @@ terminal | shell
username | login
dbt Cloud CLI | CLI, dbt CLI
dbt Core | CLI, dbt CLI
</div></b>
</b>

Note, let's make sure we're talking to our readers and keep them close to the content and documentation (second person).

Expand Down
19 changes: 10 additions & 9 deletions contributing/lightbox.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,14 +14,15 @@ You can use the Lightbox component to add an image or screenshot to your page. I

## Example usage

<code><Lightbox</code><br>
<code>src="/img/hamburger-icon.jpg"</code><br>
<code>lt="Alt text"</code><br>
<code>title="This text is visible"</code><br>
<code>collapsed={true}</code><br>
<code>width="600px"</code><br>
<code>alignment="left"</code><br>
<code>/></code>

```mdx
<Lightbox
src="/img/hamburger-icon.jpg"
lt="Alt text"
title="This text is visible"
collapsed={true}
width="600px"
alignment="left"
/>
```

<LoomVideo id="2b64dbd47a2d46dbafa5b43ed52a91e0" />
9 changes: 5 additions & 4 deletions contributing/single-sourcing-content.md
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ Below is how we can implement the same versioning using the new **VersionBlock**

You see this block when the selected version is >= 0.21:

```markdown
```code
<VersionBlock firstVersion="0.21">
Expand All @@ -116,11 +116,12 @@ $ dbt run --select [...] --defer --state path/to/artifacts
$ dbt test --select [...] --defer --state path/to/artifacts
\```
```
</VersionBlock>
You see this version block when the selected version is <= 0.20
```

```markdown
You see this version block when the selected version is `<= 0.20`

```code
<VersionBlock lastVersion="0.20">
```shell
Expand Down
2 changes: 1 addition & 1 deletion website/blog/2021-09-11-sql-dateadd.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ canonical_url: https://docs.getdbt.com/sql-reference/dateadd

authors: david_krevitt

tags: [SQL magic]
tags: [sql magic]
hide_table_of_contents: false

date: 2021-11-15
Expand Down
2 changes: 1 addition & 1 deletion website/blog/2021-09-11-union-all.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ slug: sql-union-all

authors: david_krevitt

tags: [SQL magic]
tags: [sql magic]
hide_table_of_contents: false

date: 2021-11-15
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ Some projects can afford to have older data in the warehouse, others can’t.

### 3) Simplify your regularly scheduled runs

The more complex your run commands are, the harder it gets to maintain this in the long run. Feel free to rely on dbt’s DAG (more info on why we <3 DAGs in my colleagues Christine + Randy’s [modular data modeling technique](https://getdbt.com/analytics-engineering/modular-data-modeling-technique/) post).
The more complex your run commands are, the harder it gets to maintain this in the long run. Feel free to rely on dbt’s DAG (more info on why we &lt;3 DAGs in my colleagues Christine + Randy’s [modular data modeling technique](https://getdbt.com/analytics-engineering/modular-data-modeling-technique/) post).

Given those principles, we’ll now take a look at the most common run commands for production jobs, and why we think they could work for your organization! Do note that yours may vary slightly (depending on your team’s specific needs), but as long as you stick to the principles mentioned above, your project should be in good shape!

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,40 +41,28 @@ One solution I proposed back in 2019 is hiring a [data product manager](https://

<table>
<tr>
<td>Don’t
</td>
<td>Do
</td>
<td>Don’t</td>
<td>Do</td>
</tr>
<tr>
<td>Think only within the constraints of your current tooling.
</td>
<td>First define the ideal user experience, irrespective of tooling.
</td>
<td>Think only within the constraints of your current tooling.</td>
<td>First define the ideal user experience, irrespective of tooling.</td>
</tr>
<tr>
<td>Think users can simply build their own solution given a self-service interface.
</td>
<td>Recognize that hard ongoing problems require a design-focused analyst.
</td>
<td>Think users can simply build their own solution given a self-service interface.</td>
<td>Recognize that hard ongoing problems require a design-focused analyst.</td>
</tr>
<tr>
<td>Stop at the data visualization.
</td>
<td>Think about how to group visualizations, the interactions, and purpose-built exploratory flows.
</td>
<td>Stop at the data visualization.</td>
<td>Think about how to group visualizations, the interactions, and purpose-built exploratory flows.</td>
</tr>
<tr>
<td>Ignore look and feel.
</td>
<td>Think about the overall aesthetics of your output.
</td>
<td>Ignore look and feel.</td>
<td>Think about the overall aesthetics of your output.</td>
</tr>
<tr>
<td>Just respond to tickets and user requests.
</td>
<td>Truly try to understand the problem and design the appropriate solution.
</td>
<td>Just respond to tickets and user requests.</td>
<td>Truly try to understand the problem and design the appropriate solution.</td>
</tr>
</table>

Expand Down Expand Up @@ -104,58 +92,40 @@ Here are a few examples:

<table>
<tr>
<td><strong>Traditional Dashboards</strong>
</td>
<td><strong>Analytical Applications</strong>
</td>
<td><strong>Traditional Dashboards</strong></td>
<td><strong>Analytical Applications</strong></td>
</tr>
<tr>
<td>Built for generic use cases
</td>
<td>Purpose-built for specific use cases
</td>
<td>Built for generic use cases</td>
<td>Purpose-built for specific use cases</td>
</tr>
<tr>
<td>Standard dashboard interactions
</td>
<td>Interactive based on the desired workflow
</td>
<td>Standard dashboard interactions</td>
<td>Interactive based on the desired workflow</td>
</tr>
<tr>
<td>Fixed, static layout
</td>
<td>Dynamic layout determined by logic
</td>
<td>Fixed, static layout</td>
<td>Dynamic layout determined by logic</td>
</tr>
<tr>
<td>Each element is a tile
</td>
<td>Elements can be grouped and purposefully-arranged
</td>
<td>Each element is a tile</td>
<td>Elements can be grouped and purposefully-arranged</td>
</tr>
<tr>
<td>Filters are global
</td>
<td>Users have preferences and their own defaults
</td>
<td>Filters are global</td>
<td>Users have preferences and their own defaults</td>
</tr>
<tr>
<td>Minimal software development lifecycle
</td>
<td>Strong SDLC to promote user trust
</td>
<td>Minimal software development lifecycle</td>
<td>Strong SDLC to promote user trust</td>
</tr>
<tr>
<td>Look and feel are ignored
</td>
<td>Custom look and feel to match company products
</td>
<td>Look and feel are ignored</td>
<td>Custom look and feel to match company products</td>
</tr>
<tr>
<td>Low bar for performance
</td>
<td>High bar for performance
</td>
<td>Low bar for performance</td>
<td>High bar for performance</td>
</tr>
</table>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ The most important thing we’re introducing when your project is an infant is t

* Configure your first [sources](/docs/build/sources)

* Introduce modularity with [{{ ref() }}](/reference/dbt-jinja-functions/ref) and [{{ source() }}](/reference/dbt-jinja-functions/source)
* Introduce modularity with [\{\{ ref() \}\}](/reference/dbt-jinja-functions/ref) and [\{\{ source() \}\}](/reference/dbt-jinja-functions/source)

* [Document](/docs/build/documentation) and [test](/docs/build/data-tests) your first models

Expand All @@ -99,9 +99,9 @@ Specifically, now is when it's useful to introduce **_modularity_** to our proje

We’re going to:

* Break out reused code into separate models and use [{{ ](/reference/dbt-jinja-functions/ref)[ref](/reference/dbt-jinja-functions/ref)[() }}](/reference/dbt-jinja-functions/ref) to build dependencies
* Break out reused code into separate models and use [\{\{ ref() }}](/reference/dbt-jinja-functions/ref) to build dependencies

* Use the[ {{ source() }}](/reference/commands/source) macro to declare our raw data dependencies
* Use the[ \{\{ source() \}\}](/reference/commands/source) macro to declare our raw data dependencies

* Dip our toes into testing and documenting our models

Expand Down
2 changes: 1 addition & 1 deletion website/blog/2022-06-30-coalesce-sql.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ slug: coalesce-sql-love-letter

authors: [kira_furuichi]

tags: [SQL Magic]
tags: [sql magic]
hide_table_of_contents: false

date: 2022-05-08
Expand Down
2 changes: 1 addition & 1 deletion website/blog/2022-06-30-extract-sql-function.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ slug: extract-sql-love-letter

authors: [kira_furuichi]

tags: [SQL Magic]
tags: [sql magic]
hide_table_of_contents: false

date: 2022-05-15
Expand Down
2 changes: 1 addition & 1 deletion website/blog/2022-06-30-lower-sql-function.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ canonical_url: https://docs.getdbt.com/sql-reference/lower

authors: [kira_furuichi]

tags: [SQL Magic]
tags: [sql magic]
hide_table_of_contents: false

date: 2022-05-11
Expand Down
2 changes: 1 addition & 1 deletion website/blog/2022-07-05-date-trunc-sql-love-letter.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ date_trunc(<date/time field>, <date part>)
```

> **A note on BigQuery:**
> BigQuery’s DATE_TRUNC function supports the truncation of date types, whereas Snowflake, Redshift, and Databricks’ <date/time field> can be a date or timestamp data type. BigQuery also supports DATETIME_TRUNC and TIMESTAMP_TRUNC functions to support truncation of more granular date/time types.
> BigQuery’s DATE_TRUNC function supports the truncation of date types, whereas Snowflake, Redshift, and Databricks’ `date/time field` can be a date or timestamp data type. BigQuery also supports DATETIME_TRUNC and TIMESTAMP_TRUNC functions to support truncation of more granular date/time types.

## A dbt macro to remember

Expand Down
2 changes: 1 addition & 1 deletion website/blog/2022-07-26-configuring-grants.md
Original file line number Diff line number Diff line change
Expand Up @@ -204,6 +204,6 @@ This is just a sample of the issues we've seen:
- [Post hooks that call macros get parsed with execute = False #2370](https://github.com/dbt-labs/dbt-core/issues/2370)
- [get_relation returns none in hook context #2938](https://github.com/dbt-labs/dbt-core/issues/2938)
- [this.is_view and this.is_table not working in BigQuery inside a hook #3529](https://github.com/dbt-labs/dbt-core/issues/3529)
- [custom table schema path of {{ this }} parsed in correctly in post-hook macro #3985](https://github.com/dbt-labs/dbt-core/issues/3985)
- [custom table schema path of \{\{ this \}\} parsed in correctly in post-hook macro #3985](https://github.com/dbt-labs/dbt-core/issues/3985)
- [Post-hook doesn't resolve custom schema #4023](https://github.com/dbt-labs/dbt-core/issues/4023)
- [[CT-80] [Bug] post-hook macro generates SQL with incorrect source table #4606](https://github.com/dbt-labs/dbt-core/issues/4606)
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ When I'm happy with the results, I use the [ready-made dlt Sheets source connect

For transforming I use my favorite solution, dbt Core. For running and orchestrating dbt on Cloud Functions, I am using dlt’s dbt Core runner. The benefit of the runner in this context is that I can re-use the same credential setup, instead of creating a separate profiles.yml file.

This is the package I created: <https://github.com/euanjohnston-dev/idealista_dbt_pipeline>
This is the package I created: [https://github.com/euanjohnston-dev/idealista_dbt_pipeline](https://github.com/euanjohnston-dev/idealista_dbt_pipeline)

### Production-readying the pipeline

Expand Down
4 changes: 2 additions & 2 deletions website/blog/categories.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,9 @@
display_title: dbt tutorials
description: Best practices in the usage of our favorite data transformation tool.
is_featured: true
- name: SQL magic
- name: sql magic
display_title: SQL magic
description: Stories of dbt developers making SQL sing across warehouses.
is_featured: true
- name: dbt Cloud
description: Using dbt Cloud to build for scale
description: Using dbt Cloud to build for scale
Loading
Loading