Guides V2

[john-rock]

What are you changing in this pull request and why?

Documentation will be updated with the following as well before the PR is merged.

This PR introduces several updates to the Guides collection.

1. Guide index page has been refactor to pull the initial content from a _config markdown file - This will allow the team to set which guides initially appear on the page as well as the categories they appear under.

2. Sidebar and filter refactor - In addition to a new sidebar, the filters within the sidebar have also been refactored in an effort to make it easier to add filters in the future. The FILTER_CONFIG object within the guide index.js file allows new filters to be added simply by creating a new object within the config and setting the correct values. The filter sidebar will automatically be populated from FILTER_CONFIG.

4. Favoriting Guides - Each individual guide now has the ability to be favorited. Once favorited the guide will appear on the guide index page in the Favorites category. Because of the limitations on the platform, the saved favorite values will be written to local storage meaning that favorites will only appear on the browser they were favorited on, the same way the progress is saved on the guides.

6. Updated tag - The updated tag has been refactored to read from a last_updated value on the guide markdown file. The user writing the guide can manually add the date that the guide was updated, we then take that date and pass it into a function which calculates if the guide was updated within the last 10 days. If the guide was updated in the last 10 days an Updated tag will automatically show. If the guide has been updated more than 10 days ago then the Updated tag will automatically be removed.

Testing steps

1. Confirm guide index page content is being pulled in from _config.md.
2. Attempt to use filters in sidebar. Confirm all applied filters return the corresponding guides.
3. Confirm select all, clear all, and view all buttons work in the sidebar.
4. Navigate into any guide. Confirm it loads as expected.
5. Within that guide, attempt to use the star button to favorite the guide.
6. Return to the guide index page and confirm favorited guide has been added to the Favorite category.
7. On the guide index, confirm https://docs-getdbt-com-git-upgrade-guides-v2-dbt-labs.vercel.app/guides/athena has the Updated tag visible.
8. On the guide index, confirm https://docs-getdbt-com-git-upgrade-guides-v2-dbt-labs.vercel.app/guides/azure-synapse-analytics does not have the Updated tag visible. (A past last_updated value has been set on this guide to demonstrate the automatically updating tag which will be removed before merging.)
9. Confirm _config.md is not visible anywhere in the docs content.

Before merge

• Update index page with guides needed for launch
• Remove updated tag on athena-qs
• Remove updated tag on azure-synapse-analytics
• Update documentation

---

🚀 Deployment available! Here are the direct links to the updated files:

• https://docs-getdbt-com-git-upgrade-guides-v2-dbt-labs.vercel.app/guides/_config
• https://docs-getdbt-com-git-upgrade-guides-v2-dbt-labs.vercel.app/guides/athena-qs
• https://docs-getdbt-com-git-upgrade-guides-v2-dbt-labs.vercel.app/guides/azure-synapse-analytics-qs

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Updated (UTC)
docs-getdbt-com	✅ Ready (Inspect)	Visit Preview	Feb 19, 2025 2:16pm

[JKarlavige]

The cards collapse down much better after your edits. Just one more small edit request for mobile. The cards remain 2x2 on mobile now, and get a bit smooshed. Once that's sorted out i'm ready to approve!

[john-rock]

The cards collapse down much better after your edits. Just one more small edit request for mobile. The cards remain 2x2 on mobile now, and get a bit smooshed. Once that's sorted out i'm ready to approve!

This carousel is going to be the death of me 😆 I thought I had a fix applied for that

[JKarlavige]

The cards collapse down much better after your edits. Just one more small edit request for mobile. The cards remain 2x2 on mobile now, and get a bit smooshed. Once that's sorted out i'm ready to approve!

This carousel is going to be the death of me 😆 I thought I had a fix applied for that

I sympathize with you there, they are definitely a pain to work with

[JKarlavige]

lgtm! Awesome work with this 🚀