Guides V2 #6855
Guides V2 #6855
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
github-actions
bot
added
content
| --- | ||
| title: Browse our guides | ||
| description: dbt Cloud is the fastest and most reliable way to deploy your dbt jobs and dbt Core is a powerful open-source tool for data transformations. With the help of a sample project, learn how to quickly start using dbt and one of the most common data platforms. | ||
| categories: | ||
| - title: Quickstarts | ||
| guides: | ||
| - athena | ||
| - azure-synapse-analytics | ||
| - bigquery | ||
| - title: Most popular | ||
| guides: | ||
| - core-to-cloud-3 | ||
| - set-up-your-databricks-dbt-project | ||
| - debug-errors | ||
| --- |
There was a problem hiding this comment.
Hey @mirnawong1 👋 this is still a WIP but wanted to get your thoughts on this approach so far.
Right now this new _config file controls the initial content for the guide index page.
The categories property contains a title and guides key. The guides that are pulled into this category are set by the id property from the guide front matter.
These categories will show only when no filters are selected. Once a filter is selected any applicable guide to the filter will be returned.
You can see this in action here https://docs-getdbt-com-git-upgrade-guides-v2-dbt-labs.vercel.app/guides
Lmk what you think
There was a problem hiding this comment.
hey @john-rock , this looks so awesome! great approach and improvement to the existing view. the docs team had a couple of questions/feedback items:
- for each category, if there's more than 3 cards -- will there be an arrow or carousel icon allowing them to side scroll the options?
- can we maek make quickstart header (or other category header) a link to take to all quickstarts?
- can we make the 'see all' button be more visible or apparent instead of being next to checkboxes?
There was a problem hiding this comment.
but wow, this looks awesome!
There was a problem hiding this comment.
Cool, great feedback!
for each category, if there's more than 3 cards -- will there be an arrow or carousel icon allowing them to side scroll the options?
Currently they will just continue to stack in the grid but I can definitely see if we can add a carousel for when there are >3.
can we maek make quickstart header (or other category header) a link to take to all quickstarts?
This may be a little tricky. It would work well if we were only using headers for the actual filters but in the preview above we have "Most Popular" which is not a filter. I would say if we want the headers clickable we would only want to use category titles that are also filters than I can add the logic when clicked to automatically apply that filter. Lmk what you think.
can we make the 'see all' button be more visible or apparent instead of being next to checkboxes?
Yep we can do that! Do you have a preference of any style or location adjustments here? I can also pull in madelyn if needed.
There was a problem hiding this comment.
awesome thank you! going to cc @matthewshaver @runleonarun @nataliefiann for the last two items as they'll have insight into what you're suggesting 🙏
on my end, i do like a 'most popular' option and think that's a good suggestion you have there.
What are you changing in this pull request and why?
Checklist
🚀 Deployment available! Here are the direct links to the updated files: