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.

Sign up for GitHub

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

Document shell support in user guide #420

Merged
merged 2 commits into from
Dec 4, 2024
Merged

Document shell support in user guide #420

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cc33ed7
Fixed broken link in user guide
TrevCraw Dec 4, 2024
9da3b81
Added terminal shell support documentation to user guide
TrevCraw Dec 4, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 11 additions & 1 deletion docs/user-guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,8 @@ For information regarding known issues and limitations, refer to our [Common Iss
- [Software requirements](#software-requirements)
- [Application requirements](#application-requirements)
- [Configure your Java runtime for language servers](#configure-your-java-runtime-for-language-servers)
- [External Settings](#external-settings)
- [External extension settings](#external-extension-settings)
- [Terminal shell support](#terminal-shell-support)
- [Open the Liberty dashboard](#open-the-liberty-dashboard)
- [Run your application on Liberty using dev mode](#run-your-application-on-liberty-using-dev-mode)
- [Use the Liberty dashboard](#use-the-liberty-dashboard)
Expand Down Expand Up @@ -76,6 +77,15 @@ For LemMinX, Liberty Tools for Visual Studio Code will check for the Java versio
| `xml.java.home` | This setting allows a user to define their LemMinX language server runtime without altering the `JAVA_HOME` environment variable. | Not set |
| `java.jdt.ls.java.home` | This setting specifies the folder path to the JDK (17 or later) that is used to launch the Java Language Server. This setting replaces the Java extension's embedded JRE to start the language servers. | Not set |

### Terminal shell support

Liberty Tools supports the default shell types for each OS in the Visual Studio Code terminal. These include:
- Linux: Bash or sh
- macOS: Bash or Zsh
- Windows: Command Prompt (cmd.exe)

It may be possible to use other shell types, but support is not guaranteed. Please feel free to open an enhancement issue if your preferred shell type is not supported: https://github.com/OpenLiberty/liberty-tools-vscode/issues.

## Open the Liberty dashboard

By default, the Liberty dashboard appears in the Project Explorer side bar. Optionally, you can drag the Liberty dashboard into the Activity Bar.
Expand Down
Loading