Skip to content

Commit 33c7d68

Browse files
Mike Niklesjeanp413
authored andcommitted
Add a Get Started with Gitpod walkthrough.
1 parent 8dc3285 commit 33c7d68

File tree

10 files changed

+177
-1
lines changed

10 files changed

+177
-1
lines changed

extensions/gitpod-remote/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
"icon": "resources/gitpod.png",
1010
"repository": {
1111
"type": "git",
12-
"url": "https://github.com/gitpod-io/vscode.git"
12+
"url": "https://github.com/gitpod-io/openvscode-server.git"
1313
},
1414
"bugs": {
1515
"url": "https://github.com/gitpod-io/gitpod/issues"

extensions/gitpod-web/package.json

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,14 @@
55
"publisher": "gitpod",
66
"version": "0.0.1",
77
"license": "MIT",
8+
"icon": "resources/gitpod.png",
9+
"repository": {
10+
"type": "git",
11+
"url": "https://github.com/gitpod-io/openvscode-server.git"
12+
},
13+
"bugs": {
14+
"url": "https://github.com/gitpod-io/gitpod/issues"
15+
},
816
"engines": {
917
"vscode": "^1.58.2"
1018
},
@@ -430,6 +438,54 @@
430438
"label": "GitHub"
431439
}
432440
],
441+
"walkthroughs": [{
442+
"id": "gitpod-getstarted",
443+
"title": "Get Started with Gitpod",
444+
"description": "Explore what Gitpod is and how to get the most out of it.",
445+
"steps": [{
446+
"id": "whatisgitpod",
447+
"title": "What is Gitpod?",
448+
"description": "",
449+
"media": {
450+
"markdown": "resources/walkthroughs/getstarted/what-is-gitpod.md"
451+
}
452+
}, {
453+
"id": "prebuilds",
454+
"title": "Prebuilds do the heavy lifting",
455+
"description": "",
456+
"media": {
457+
"markdown": "resources/walkthroughs/getstarted/prebuilds.md"
458+
}
459+
}, {
460+
"id": "workspaces",
461+
"title": "A new workspace per task",
462+
"description": "",
463+
"media": {
464+
"markdown": "resources/walkthroughs/getstarted/workspaces.md"
465+
}
466+
}, {
467+
"id": "terminal",
468+
"title": "Full access to a terminal",
469+
"description": "",
470+
"media": {
471+
"markdown": "resources/walkthroughs/getstarted/terminal.md"
472+
}
473+
}, {
474+
"id": "ports",
475+
"title": "Open ports",
476+
"description": "",
477+
"media": {
478+
"markdown": "resources/walkthroughs/getstarted/ports.md"
479+
}
480+
}, {
481+
"id": "vscodedesktopsupport",
482+
"title": "VS Code desktop support",
483+
"description": "",
484+
"media": {
485+
"markdown": "resources/walkthroughs/getstarted/vscodedesktopsupport.md"
486+
}
487+
}]
488+
}],
433489
"configuration": {
434490
"title": "Gitpod",
435491
"properties": {
24.1 KB
Loading
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Ports
2+
3+
If your application listens on any port, e.g. a web application, Gitpod provides a URL for you to access your application.
4+
5+
A list of ports is available in the "Remote Explorer" panel on the left-hand side. [Click here to open the panel.](command:gitpod.ports.reveal)
6+
7+
_Note_: To get back to the list of files in your project, click the "Explorer" icon on the left-hand side.
8+
9+
## Documentation
10+
11+
To learn more about ports and how to configure them, please [refer to the documentation](https://www.gitpod.io/docs/config-ports).
Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# Prebuilds
2+
3+
Download & install dependencies, run build scripts, you name it - tell Gitpod which tasks to run and it takes care of them **before** you start a new developer environment so you don’t have to wait for any of that.
4+
5+
When new code is pushed to the repository, Gitpod automatically prepares a new workspace based on the latest code.
6+
7+
By the time you start your next workspace, everything is installed, compiled and ready for you to write code.
8+
9+
## Documentation
10+
11+
To learn more and how to enable prebuilds for your project, please [refer to the documentation](https://www.gitpod.io/docs/prebuilds).
12+
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# The terminal
2+
3+
Gitpod is more than just an editor - it's everything you need to develop, test & debug your application.
4+
5+
With that, you also have access to a terminal, including Docker support.
6+
7+
Let's open a new terminal and run the following command in the terminal:
8+
9+
```bash
10+
docker run hello-world
11+
```
12+
13+
Alternatively, [click here](command:gitpod.welcome.createTerminalAndRunDockerCommand) to perform the above automatically.
14+
15+
Just like you used the `hello-world` Docker image, you can containerize your own application right on Gitpod.
16+
17+
To exit a terminal, type `exit` and hit Enter.
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# VS Code desktop support
2+
3+
If you like the idea of ephemeral workspaces, but prefer to develop code in your local VS Code, we've got you covered.
4+
5+
Depending on the version of VS Code you have installed locally, use one of the following links to start your VS Code and connect to the currently running workspace:
6+
* [Open in VS Code](command:gitpod.openInStable)
7+
* [Open in VS Code Insiders](command:gitpod.openInInsiders)
8+
9+
## Documentation
10+
11+
To learn more about VS Code desktop support, please [refer to the documentation](https://www.gitpod.io/docs/develop/vscode-desktop-support).
Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# What is Gitpod?
2+
3+
With Gitpod, you spin up fresh, automated dev environments for each task, in the cloud, in seconds.
4+
5+
- Develop a new feature? Start a new workspace.
6+
- Review a pull request? Start a new workspace.
7+
- Fix a bug in production? Start a new workspace.
8+
9+
You can even run multiple workspaces in parallel and they are 100% isolated from each other.
10+
11+
## User interface
12+
13+
As you notice, Gitpod looks & feels like VS Code - except it runs in a browser. On Gitpod, you can install extensions, apply themes and use a terminal just as you're used to from your local computer.
14+
15+
## Features
16+
17+
Use the steps on the left side to learn more about the following features:
18+
19+
* Prebuilds
20+
* Workspaces
21+
* The terminal
22+
* Ports
23+
* VS Code desktop support
24+
25+
## Browser extension
26+
27+
To be most productive with Gitpod, it is best if you [install the browser extension](https://www.gitpod.io/docs/browser-extension). It will add a convenient "Gitpod" button when you look at your repo, an issue or a pull request.
28+
29+
The most productive way to use Gitpod is by installing its browser extension.
30+
31+
## Documentation
32+
33+
To learn more about Gitpod, how to customize it and about best practices, please [check out the documentation](https://www.gitpod.io/docs).
34+
35+
## Community
36+
37+
Come [join us in our chat](https://www.gitpod.io/chat) to learn from others and share what you're up to.
Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# Workspaces
2+
3+
When you work with Gitpod, your goal is to open as many workspaces as possible ;-). To be more specific, you want to open a new workspace for each task you work on. We call this ephemeral workspaces.
4+
5+
## Benefits of ephemeral workspaces
6+
7+
### Latest code
8+
9+
Each new workspace contains the latest code. There's no need for you to take care of that.
10+
11+
As an added bonus, if you open a Gitpod workspace from an issue URL, Gitpod automatically creates a branch for you! All you need to do is write the code, commit & push.
12+
13+
### Latest dependencies
14+
15+
Each new workspace also has the most up-to-date versions of app & operating system dependencies. Another thing you don't have to worry about.
16+
17+
### Work in parallel
18+
19+
Say you're working on a feature and a team member asks you to review their pull request. Start a new workspace, review the code, close the workspace - and you're back in your feature environment where you continue to work.
20+
21+
## Documentation
22+
23+
To learn more about workspaces, please [refer to the documentation](https://www.gitpod.io/docs/workspaces).

extensions/gitpod-web/src/extension.ts

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,7 @@ export async function activate(context: vscode.ExtensionContext) {
3838
location: parentTerminal ? { parentTerminal } : vscode.TerminalLocation.Panel
3939
});
4040
});
41+
registerWelcomeWalkthroughCommands(gitpodContext);
4142

4243
const codeServer = new GitpodCodeServer();
4344
registerCLI(codeServer, gitpodContext);
@@ -754,6 +755,14 @@ export function registerPorts(context: GitpodExtensionContext): void {
754755
}));
755756
}
756757

758+
export function registerWelcomeWalkthroughCommands(context: GitpodExtensionContext): void {
759+
context.subscriptions.push(vscode.commands.registerCommand('gitpod.welcome.createTerminalAndRunDockerCommand', () => {
760+
const terminal = vscode.window.createTerminal('Welcome');
761+
terminal.show();
762+
terminal.sendText('docker run hello-world');
763+
}));
764+
}
765+
757766
export function registerCLI(codeServer: GitpodCodeServer, context: GitpodExtensionContext): void {
758767
const ipcHookCli = context.ipcHookCli;
759768
if (context.ipcHookCli) {

0 commit comments

Comments
 (0)