Skip to content

Commit

Permalink
Adding landing pages for autogenerated FAQ directories (#4560)
Browse files Browse the repository at this point in the history
Closes #2748

## What are you changing in this pull request and why?

Adding a page that will hopefully add a landing page. This will ensure
breadcrumbs work which helps with SEO and will help @kbrock91 be able to
link to a section in the FAQs when necessary.

## 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/docs/dbt-versions/core-upgrade)
-->
- [ ] Review 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.
- [ ] For [docs
versioning](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/single-sourcing-content.md#about-versioning),
review how to [version a whole
page](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/single-sourcing-content.md#adding-a-new-version)
and [version a block of
content](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/single-sourcing-content.md#versioning-blocks-of-content).
- [ ] 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`
- [ ] Run link testing locally with `npm run build` to update the links
that point to the deleted page

---------

Co-authored-by: Matt Shaver <[email protected]>
  • Loading branch information
runleonarun and matthewshaver authored Nov 30, 2023
1 parent f269168 commit 7fc3cbf
Show file tree
Hide file tree
Showing 15 changed files with 150 additions and 0 deletions.
10 changes: 10 additions & 0 deletions website/docs/faqs/API/_category_.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# position: 2.5 # float position is supported
label: 'API'
collapsible: true # make the category collapsible
collapsed: true # keep the category collapsed by default
className: red
link:
type: generated-index
title: API FAQs
customProps:
description: Frequently asked questions about dbt APIs
10 changes: 10 additions & 0 deletions website/docs/faqs/Accounts/_category_.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# position: 2.5 # float position is supported
label: 'Accounts'
collapsible: true # make the category collapsible
collapsed: true # keep the category collapsed by default
className: red
link:
type: generated-index
title: Account FAQs
customProps:
description: Frequently asked questions about your account in dbt
10 changes: 10 additions & 0 deletions website/docs/faqs/Core/_category_.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# position: 2.5 # float position is supported
label: 'dbt Core'
collapsible: true # make the category collapsible
collapsed: true # keep the category collapsed by default
className: red
link:
type: generated-index
title: 'dbt Core FAQs'
customProps:
description: Frequently asked questions about dbt Core
10 changes: 10 additions & 0 deletions website/docs/faqs/Docs/_category_.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# position: 2.5 # float position is supported
label: 'dbt Docs'
collapsible: true # make the category collapsible
collapsed: true # keep the category collapsed by default
className: red
link:
type: generated-index
title: dbt Docs FAQs
customProps:
description: Frequently asked questions about dbt Docs
10 changes: 10 additions & 0 deletions website/docs/faqs/Environments/_category_.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# position: 2.5 # float position is supported
label: 'Environments'
collapsible: true # make the category collapsible
collapsed: true # keep the category collapsed by default
className: red
link:
type: generated-index
title: 'Environments FAQs'
customProps:
description: Frequently asked questions about Environments in dbt
10 changes: 10 additions & 0 deletions website/docs/faqs/Git/_category_.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# position: 2.5 # float position is supported
label: 'Git'
collapsible: true # make the category collapsible
collapsed: true # keep the category collapsed by default
className: red
link:
type: generated-index
title: Git FAQs
customProps:
description: Frequently asked questions about Git and dbt
10 changes: 10 additions & 0 deletions website/docs/faqs/Jinja/_category_.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# position: 2.5 # float position is supported
label: 'Jinja'
collapsible: true # make the category collapsible
collapsed: true # keep the category collapsed by default
className: red
link:
type: generated-index
title: Jinja FAQs
customProps:
description: Frequently asked questions about Jinja and dbt
10 changes: 10 additions & 0 deletions website/docs/faqs/Models/_category_.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# position: 2.5 # float position is supported
label: 'Models'
collapsible: true # make the category collapsible
collapsed: true # keep the category collapsed by default
className: red
link:
type: generated-index
title: Models FAQs
customProps:
description: Frequently asked questions about Models in dbt
10 changes: 10 additions & 0 deletions website/docs/faqs/Project/_category_.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# position: 2.5 # float position is supported
label: 'Projects'
collapsible: true # make the category collapsible
collapsed: true # keep the category collapsed by default
className: red
link:
type: generated-index
title: Project FAQs
customProps:
description: Frequently asked questions about projects in dbt
10 changes: 10 additions & 0 deletions website/docs/faqs/Runs/_category_.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# position: 2.5 # float position is supported
label: 'Runs'
collapsible: true # make the category collapsible
collapsed: true # keep the category collapsed by default
className: red
link:
type: generated-index
title: Runs FAQs
customProps:
description: Frequently asked questions about runs in dbt
10 changes: 10 additions & 0 deletions website/docs/faqs/Seeds/_category_.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# position: 2.5 # float position is supported
label: 'Seeds'
collapsible: true # make the category collapsible
collapsed: true # keep the category collapsed by default
className: red
link:
type: generated-index
title: Seeds FAQs
customProps:
description: Frequently asked questions about seeds in dbt
10 changes: 10 additions & 0 deletions website/docs/faqs/Snapshots/_category_.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# position: 2.5 # float position is supported
label: 'Snapshots'
collapsible: true # make the category collapsible
collapsed: true # keep the category collapsed by default
className: red
link:
type: generated-index
title: Snapshots FAQs
customProps:
description: Frequently asked questions about snapshots in dbt
10 changes: 10 additions & 0 deletions website/docs/faqs/Tests/_category_.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# position: 2.5 # float position is supported
label: 'Tests'
collapsible: true # make the category collapsible
collapsed: true # keep the category collapsed by default
className: red
link:
type: generated-index
title: Tests FAQs
customProps:
description: Frequently asked questions about tests in dbt
10 changes: 10 additions & 0 deletions website/docs/faqs/Troubleshooting/_category_.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# position: 2.5 # float position is supported
label: 'Troubleshooting'
collapsible: true # make the category collapsible
collapsed: true # keep the category collapsed by default
className: red
link:
type: generated-index
title: Troubleshooting FAQs
customProps:
description: Frequently asked questions about troubleshooting dbt
10 changes: 10 additions & 0 deletions website/docs/faqs/Warehouse/_category_.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# position: 2.5 # float position is supported
label: 'Warehouse'
collapsible: true # make the category collapsible
collapsed: true # keep the category collapsed by default
className: red
link:
type: generated-index
title: Warehouse FAQs
customProps:
description: Frequently asked questions about warehouses and dbt

0 comments on commit 7fc3cbf

Please sign in to comment.