-
Notifications
You must be signed in to change notification settings - Fork 982
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
Changes from 11 commits
Commits
Show all changes
19 commits
Select commit
Hold shift + click to select a range
d9d5ece
new file
mirnawong1 d1e8bfd
Merge branch 'current' into keyboard-shortcut
mirnawong1 3c97f45
fi link
mirnawong1 6de88f1
Merge branch 'keyboard-shortcut' of https://github.com/dbt-labs/docs.…
mirnawong1 73e2c1c
Merge branch 'current' into keyboard-shortcut
mirnawong1 292a2fa
updates
mirnawong1 c0792b8
final tweaks
mirnawong1 4fe7eeb
turn to table
mirnawong1 5f24285
add line
mirnawong1 206a248
Merge branch 'current' into keyboard-shortcut
mirnawong1 bd8fa09
Update vercel.json
mirnawong1 1b659c9
Merge branch 'current' into keyboard-shortcut
mirnawong1 574988e
fold feedback
mirnawong1 ff0b5e9
fold feedback
mirnawong1 fa7b908
Merge branch 'current' into keyboard-shortcut
mirnawong1 3bcf8f0
fold feedback
mirnawong1 0ee6385
Merge branch 'keyboard-shortcut' of https://github.com/dbt-labs/docs.…
mirnawong1 6e0fd2e
Merge branch 'current' into keyboard-shortcut
mirnawong1 b81b041
Merge branch 'current' into keyboard-shortcut
matthewshaver File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -10,7 +10,7 @@ pagination_prev: null | |
|
||
The dbt Cloud integrated development environment (IDE) is a single web-based interface for building, testing, running, and version-controlling dbt projects. It compiles dbt code into SQL and executes it directly on your database. | ||
|
||
The dbt Cloud IDE offers several [editing features](/docs/cloud/dbt-cloud-ide/ide-user-interface#editing-features) for faster and more efficient data platform development and governance: | ||
The dbt Cloud IDE offers several [keyboard shortcuts](/docs/cloud/dbt-cloud-ide/keyboard-shortcuts) and [editing features](/docs/cloud/dbt-cloud-ide/ide-user-interface#editing-features) for faster and more efficient data platform development and governance: | ||
|
||
- Syntax highlighting for SQL: Makes it easy to distinguish different parts of your code, reducing syntax errors and enhancing readability. | ||
- Auto-completion: Suggests table names, arguments, and column names as you type, saving time and reducing typos. | ||
|
@@ -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. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. |
||
|
||
:::tip Stay informed | ||
|
||
|
@@ -54,7 +54,7 @@ To stay informed on IDE updates, read [dbt Cloud IDE release notes](/tags/ide), | |
|
||
| Feature | Info | | ||
|---|---| | ||
| **Keyboard shortcuts** | You can access a variety of [commands and actions](/docs/cloud/dbt-cloud-ide/dbt-cloud-tips#cloud-ide-keyboard-shortcuts) in the IDE by choosing the appropriate keyboard shortcut. This includes the command palette (Command-P or Control-P), which has common shortcuts and build commands to optimize your developer workflow. For example, you can build modified models or continue the build from the last failure point. | | ||
| **Keyboard shortcuts** | You can access a variety of [commands and actions](/docs/cloud/dbt-cloud-ide/keyboard-shortcuts) in the IDE by choosing the appropriate keyboard shortcut. This includes the command palette (Command-P or Control-P), which has common shortcuts and build commands to optimize your developer workflow. For example, you can build modified models or continue the build from the last failure point. | | ||
| **File state indicators** | Ability to see when changes or actions have been made to the file. The indicators **M, D, A,** and **•** appear to the right of your file or folder name and indicate the actions performed: <br /> <br /> - Unsaved **(•)** — The IDE detects unsaved changes to your file/folder<br /> - Modification **(M)** — The IDE detects a modification of existing files/folders<br /> - Added **(A)** — The IDE detects added files<br/> - Deleted **(D)** — The IDE detects deleted files. | ||
| **IDE version control** | The IDE version control section and git button allow you to apply the concept of [version control](/docs/collaborate/git/version-control-basics) to your project directly into the IDE. <br /><br /> - Create or change branches<br /> - Commit or revert individual files by right-clicking the edited file<br /> - [Resolve merge conflicts](/docs/collaborate/git/merge-conflicts)<br /> - Execute git commands using the git button <br /> - Link to the repo directly by clicking the branch name | | ||
| **Project documentation** | Generate and view your [project documentation](/docs/collaborate/build-and-view-your-docs) for your dbt project in real-time. You can inspect and verify what your project's documentation will look like before you deploy your changes to production. | | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
29 changes: 29 additions & 0 deletions
29
website/docs/docs/cloud/dbt-cloud-ide/keyboard-shortcuts.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
--- | ||
title: "dbt Cloud IDE keyboard shortcuts" | ||
description: "Learn about the keyboard shortcuts available in the Cloud IDE." | ||
sidebar_label: "Keyboard shortcuts" | ||
--- | ||
|
||
|
||
The Cloud IDE provides keyboard shortcuts, features, and development tips to help you work faster and be more productive. | ||
|
||
Use this dbt Cloud IDE page to help you quickly reference some common operations. | ||
|
||
| Shortcut description | macOS | Windows | | ||
|--------|----------------|------------------| | ||
| View a full list of editor shortcuts | Fn-F1 | Fn-F1 | | ||
| Select a file to open | Command-O | Control-O | | ||
| Open the command palette to invoke dbt commands and actions | Command-P or Command-Shift-P | Control-P or Control-Shift-P | | ||
| Multi-edit by selecting multiple lines | Option-click or Shift-Option-Command | Hold Alt and click | | ||
| Preview code | Command-Enter | Control-Enter | | ||
| Compile code | Command-Shift-Enter | Control-Shift-Enter | | ||
| Reveal a list of dbt functions | Enter two underscores `__` | Enter two underscores `__` | | ||
mirnawong1 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| Toggle open the [Invocation history drawer](/docs/cloud/dbt-cloud-ide/ide-user-interface#invocation-history) located on the bottom of the IDE. | Control-backtick (or Control + `) | Control-backtick (or Ctrl + `) | | ||
| Add a block comment to selected code. SQL files will use the Jinja syntax `({# #})` rather than the SQL one `(/* */)`.<br /> <br /> Markdown files will use the Markdown syntax `(<!-- -->)` | Command-Option-/ | Control-Alt-/ | | ||
| Close the currently active editor tab | Option-W | Alt-W | | ||
|
||
## Related docs | ||
|
||
- [Quickstart guide](/guides) | ||
- [About dbt Cloud](/docs/cloud/about-cloud/dbt-cloud-features) | ||
- [Develop in the Cloud](/docs/cloud/dbt-cloud-ide/develop-in-the-cloud) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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!