Skip to content

Commit

Permalink
Walkthrough.
Browse files Browse the repository at this point in the history
  • Loading branch information
adamdriscoll committed Mar 27, 2022
1 parent 3c3a4aa commit 5681e69
Show file tree
Hide file tree
Showing 8 changed files with 61 additions and 2 deletions.
Binary file added images/connect.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/connections.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/splash.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
37 changes: 35 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -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"
},
Expand Down Expand Up @@ -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",
Expand Down
2 changes: 2 additions & 0 deletions src/extension.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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"));
Expand Down
10 changes: 10 additions & 0 deletions walkthroughs/getting-started/1-install.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
## Install PowerShell Universal

<p align="center">
<img src="../../images/splash.png" alt="PowerShell Universal" />
</p>


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)
5 changes: 5 additions & 0 deletions walkthroughs/getting-started/2-login.md
Original file line number Diff line number Diff line change
@@ -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)
9 changes: 9 additions & 0 deletions walkthroughs/getting-started/3-connect.md
Original file line number Diff line number Diff line change
@@ -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.

<p align="center">
<img src="../../images/connect.png" alt="PowerShell Universal" />
</p>

[💡 Settings \ Configurations](http://localhost:5000)

0 comments on commit 5681e69

Please sign in to comment.