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

revise keyboard shortcut page #4630

Merged
merged 19 commits into from
Dec 18, 2023
Merged

revise keyboard shortcut page #4630

merged 19 commits into from
Dec 18, 2023

Conversation

mirnawong1
Copy link
Contributor

this pr revamps the keyboard shortcuts into its own page and a table format. it also moves the tips and tricks page under 'build your dag' to emcompass cloud and core users since the content is applicable to both.

Resolves #4607

@mirnawong1 mirnawong1 requested a review from a team as a code owner December 12, 2023 18:15
Copy link

vercel bot commented Dec 12, 2023

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

Name Status Preview Comments Updated (UTC)
docs-getdbt-com ✅ Ready (Inspect) Visit Preview 💬 Add feedback Dec 18, 2023 7:04pm

@github-actions github-actions bot added content Improvements or additions to content Docs team Authored by the Docs team @dbt Labs size: medium This change will take up to a week to address labels Dec 12, 2023
Copy link
Contributor

@ernestoongaro ernestoongaro left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great job @mirnawong1 thank you for doing this!

Copy link

vercel bot commented Dec 18, 2023

Deployment failed with the following error:

Could not parse File as JSON: website/vercel.json

fix failure

You can also learn about the default dbt Cloud IDE [keyboard shortcuts](/docs/cloud/dbt-cloud-ide/keyboard-shortcuts) to help make development more productive and easier for everyone.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The language here coupled with the sentence above makes it seem like the keyboard shortcuts should be on this page, but the link opens a new page. Might be beneficial to clarify that.

This is probably a project for another day, but this page feels really disjointed. There's no flow or sense to the information. Maybe long term this could be broken up and put in the FAQs

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've tweaked it a little and added more context. however, feel free to open up an issue so we address this later!

@@ -44,7 +44,7 @@ To improve your experience using dbt Cloud, we suggest that you turn off ad bloc

## dbt Cloud IDE features

The dbt Cloud IDE comes with [tips](/docs/cloud/dbt-cloud-ide/dbt-cloud-tips) and [features](/docs/cloud/dbt-cloud-ide/ide-user-interface) that make it easier for you to develop, build, compile, run, and test data models.
The dbt Cloud IDE comes with [tips](/docs/build/dbt-tips) and [features](/docs/cloud/dbt-cloud-ide/ide-user-interface) that make it easier for you to develop, build, compile, run, and test data models.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is nothing on the tips page that points out anything related to the IDE. Maybe this should be the keyboard shortcuts link?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ive tweaked this too but the features table does have the keyboard shortcut on the first line and the tips page does have the ide shortcuts linked -- wondering how come it didn't show up for you?
Screenshot 2023-12-18 at 12 08 08

@mirnawong1
Copy link
Contributor Author

merging this now @ernestoongaro ! thank you for the review @matthewshaver

@mirnawong1 mirnawong1 merged commit b67bb6b into current Dec 18, 2023
7 checks passed
@mirnawong1 mirnawong1 deleted the keyboard-shortcut branch December 18, 2023 19:55
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 Docs team Authored by the Docs team @dbt Labs size: medium This change will take up to a week to address
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Improve the IDE keyboard shortcut section
3 participants