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

Fast follows for the quickstarts / guides v2 project #4432

Open
2 of 19 tasks
runleonarun opened this issue Nov 10, 2023 · 0 comments
Open
2 of 19 tasks

Fast follows for the quickstarts / guides v2 project #4432

runleonarun opened this issue Nov 10, 2023 · 0 comments
Labels
content Improvements or additions to content get-started guides Describes content related to the Guides project guides Knowledge best suited for Guides improvement Use this when an area of the docs needs improvement as it's currently unclear

Comments

@runleonarun
Copy link
Collaborator

runleonarun commented Nov 10, 2023

Contributions

  • I have read the contribution docs, and understand what's expected of me.

Link to the page on docs.getdbt.com requiring updates

https://docs.getdbt.com/guides

What part(s) of the page would you like to see updated?

Follow up content from Ly & Matt:

  • - Add time to complete for guides: we should establish guidelines and decide is it to complete or read? Reading might be more easily estimated
  • - Ask front-end if the “updated” needs to manually be removed of if they can disappear after 5 days?
  • Make sure the placeholder text is consistent. see [(->follow-up task) small nit. for http://localhost:3000/guides/how-to-use-databricks-workflows-to-run-dbt-cloud-jobs?step=3, the placeholders are all in caps which is great but it’s using angle braces which should be removed (per style guide). it should also be unbolded (in text)](https://www.notion.so/follow-up-task-small-nit-for-http-localhost-3000-guides-how-to-use-databricks-workflows-to-run-d-ac937f339afd448a86764e6b759e111f?pvs=21) and [(->follow-up task) for this step, http://localhost:3000/guides/building-packages?step=2 , package_name is not in compliance with our style for placeholders ](https://www.notion.so/follow-up-task-for-this-step-http-localhost-3000-guides-building-packages-step-2-package_name--5140aa8a992644d4b43e5cb5e87501bc?pvs=21)
  • Note: we can add something to every page/step by putting it before the ## Intro
  • Follow up with front end team: About "recently updated" If set to "true" do we need a manual process to go in and turn this off after a certain amount of time?
    This is currently a manual process of setting both true and false for this field. It was discussed in the scoping call potentially using the "last updated in github" value to automatically set the recently updated to true, but that would trigger even if there was a small typo update. There may be a way to automate setting that field to false after a set amount of time but that would require some discovery and would be just outside the scope of this project.
    • from Joel: what about a manually set "last substantive update" property, and freshness is determined based on that? So they would automatically remove the freshness indicator over time but a typo fix wouldn’t count.
  • Filtering. I see that the filtering for the topic is subtractive (each additional filter removes selections) and the level filter is additive (each additional filter adds results). The latter makes sense, and I think there's an argument to be made that it could have its uses in topics (show a user all of the quickstarts and best practices, for example). Maybe a future add is the type of guide (separate from the topic) and make it additive as well.
  • Maybe another future consideration - For guides, it might be nice to open links to our docs in a new tab. They're going through steps and following a process in order, taking them out of that page might interrupt workflows, whereas opening even our own docs in a new tab might ease their back-and-forth.
    • is it possible to add a Back to all guides link at the top of each guide page? hitting the browser back button works but it’s not 100% obvious
  • Should we also include Best Practices on our sidebar for the docs section as well? Maybe at the very bottom to help with discoverability. Moving the guide content to the new format #4361 (comment)
    • Follow-up with Design: the Docs top navigation bar could be a menu (like version), and have Best practices be a menu item, dbt Cloud API docs be another menu item.
  • sidebar seems to be taking up a lot of unnecessary space and for a lot of the guides that means pushing content off the screen, making some viewing a little uncomfortable at 100% zoom on the browser Moving the guide content to the new format #4361 (comment)
  • Follow-up : the Guides landing page could have categories like Quickstarts, User guides, Integration guides, Workshops , etc
  • Follow-up : there could be a Save feature (ie tap on ⭐ icon to favorite) so people could manage a "Reading list" / "Bookmarks"
  • Joel: Consider splitting up the CI guide into three: Set up CI in 15mins (current parts 1 & 2, beginner level), Enhance your CI setup (current parts 3 & 4, intermediate level) and Configure a Release Train (Current part 5, advanced and only intended for very large orgs with complex needs)
  • Joel: The guides landing page is overwhelming at first glance. Consider splitting out by their tags, so that there's a Quickstart header with those ones, then another one for Orchestration and so on. Not sure what we do to avoid excessive repetition and/or avoid lots of single-item sections - maybe there needs to be an additional section added in addition to the topic tags? Or the first Topic in the array is considered the most important for categorisation purposes?
  • Mirna: maybe it's just me but when I go to the guides, I’m a little overwhelmed with trying to figure out the structure of the cards. imho i think the guides page seems to list cards in any order. I wonder if we should:
    - have cards that display and categorize the topic (similar to this) as the top level OR
    - display quickstarts in the top row so it’s more prominent and the user doesn’t have to filter for it OR
    - maybe display the quickstarts as a ‘most visited’
    - if i filter the guides page, can we link to that filtered page?
    - If i filter topics, there should be a 'clear filters' button so that i don't have to click the 'x' for each one.
  • when filters are used/active, could we make the links shareable like maybe with query params?

Additional information

No response

@runleonarun runleonarun added content Improvements or additions to content improvement Use this when an area of the docs needs improvement as it's currently unclear labels Nov 10, 2023
@runleonarun runleonarun changed the title Fast follows for the Quickstarts/guides v2 project Fast follows for the quickstarts / guides v2 project Apr 9, 2024
@runleonarun runleonarun added guides Knowledge best suited for Guides get-started guides Describes content related to the Guides project labels Apr 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content Improvements or additions to content get-started guides Describes content related to the Guides project guides Knowledge best suited for Guides improvement Use this when an area of the docs needs improvement as it's currently unclear
Projects
None yet
Development

No branches or pull requests

1 participant