diff --git a/images/connect.png b/images/connect.png new file mode 100644 index 0000000..da3c180 Binary files /dev/null and b/images/connect.png differ diff --git a/images/connections.png b/images/connections.png new file mode 100644 index 0000000..db343d4 Binary files /dev/null and b/images/connections.png differ diff --git a/images/splash.png b/images/splash.png new file mode 100644 index 0000000..db9e0fc Binary files /dev/null and b/images/splash.png differ diff --git a/package.json b/package.json index 7b6da41..012e2a9 100644 --- a/package.json +++ b/package.json @@ -3,7 +3,7 @@ "displayName": "PowerShell Universal", "description": "Visual Studio Code tools for PowerShell Universal", "publisher": "ironmansoftware", - "version": "2.8.2", + "version": "2.10.0", "engines": { "vscode": "^1.46.0" }, @@ -503,7 +503,40 @@ "group": "inline" } ] - } + }, + "walkthroughs": [ + { + "id": "universal.welcome", + "title": "Get Started with PowerShell Universal", + "description": "Install and configure PowerShell Universal", + "steps": [ + { + "id": "universal.welcome.install", + "title": "Install PowerShell Universal", + "description": "Download and install the PowerShell Universal server to get started.", + "media": { + "markdown": "walkthroughs/getting-started/1-install.md" + } + }, + { + "id": "universal.welcome.login", + "title": "Login to PowerShell Universal", + "description": "Login to your PowerShell Universal instance.", + "media": { + "markdown": "walkthroughs/getting-started/2-login.md" + } + }, + { + "id": "universal.welcome.connect", + "title": "Connect VS Code to PowerShell Universal", + "description": "Connect the VS Code extension to your PowerShell Universal server.", + "media": { + "markdown": "walkthroughs/getting-started/3-connect.md" + } + } + ] + } + ] }, "scripts": { "vscode:prepublish": "npm run compile", diff --git a/src/extension.ts b/src/extension.ts index 72eabc8..e6f5dca 100644 --- a/src/extension.ts +++ b/src/extension.ts @@ -42,6 +42,8 @@ export async function activate(context: vscode.ExtensionContext) { let settings = load(); if (settings.appToken === "" && settings.connections.length === 0) { + vscode.commands.executeCommand('workbench.action.openWalkthrough', 'universal.welcome'); + vscode.window.showInformationMessage("You need to configure the PowerShell Universal extension. If you haven't installed PowerShell Universal, you should download it. If you have PowerShell Universal running, you can connect.", "Download", "Settings").then(result => { if (result === "Download") { vscode.env.openExternal(vscode.Uri.parse("https://ironmansoftware.com/downloads")); diff --git a/walkthroughs/getting-started/1-install.md b/walkthroughs/getting-started/1-install.md new file mode 100644 index 0000000..843214e --- /dev/null +++ b/walkthroughs/getting-started/1-install.md @@ -0,0 +1,10 @@ +## Install PowerShell Universal + +

+ PowerShell Universal +

+ + +PowerShell Universal is a single pane of glass for mananging your automation environment. The server is cross-platform. You can install it by using PowerShell, using a Windows MSI, with Chocolatey, or run as a Docker container. + +[Download](https://ironmansoftware.com/powershell-universal/downloads) | [💡Learn More About Installing PowerShell Universal](https://docs.powershelluniversal.com/getting-started) \ No newline at end of file diff --git a/walkthroughs/getting-started/2-login.md b/walkthroughs/getting-started/2-login.md new file mode 100644 index 0000000..0f70e5c --- /dev/null +++ b/walkthroughs/getting-started/2-login.md @@ -0,0 +1,5 @@ +## Login to PowerShell Universal + +Once you have installed PowerShell Universal, it will be listening at `http://localhost:5000`. You can login with the username `admin` and any password. + +[💡 Login to PowerShell Universal](http://localhost:5000) \ No newline at end of file diff --git a/walkthroughs/getting-started/3-connect.md b/walkthroughs/getting-started/3-connect.md new file mode 100644 index 0000000..936d6b3 --- /dev/null +++ b/walkthroughs/getting-started/3-connect.md @@ -0,0 +1,9 @@ +## Connect Visual Studio Code + +The PowerShell Unviersal Visual Studio Code extension requires connection information to login to your PowerShell Universal instance. Once logged into PowerShell Universal, click Settings \ Configurations and then Edit with VS Code. You'll be prompted and VS Code will be configured automatically. + +

+ PowerShell Universal +

+ +[💡 Settings \ Configurations](http://localhost:5000) \ No newline at end of file