Skip to content
This repository was archived by the owner on Apr 19, 2021. It is now read-only.

Commit f6ed7ef

Browse files
gtsiolisJohannes Landgraf
andauthored
Improve Getting Started section in the docs (#879)
* Update Getting Started section in the docs * Added backlink to introduction and a section for OSS Projects * Fixed some typos * Shortened backlink to Intro * Moved duplicate screenshots and reordered options * Rephrase section for GitLab integration Co-authored-by: Johannes Landgraf <[email protected]>
1 parent 6ad57b6 commit f6ed7ef

File tree

2 files changed

+46
-12
lines changed

2 files changed

+46
-12
lines changed

src/docs/context-urls.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@ Gitpod derives the workspace context from the URL of the repository page from wh
1010
started. Different issues, pull/merge requests, or branches will result in different workspaces, allowing
1111
developers to easily perform different tasks in different isolated environments.
1212

13+
![prefix github URL](./images/prefix-screenshot.png)
14+
1315
Each workspace includes a full Linux container. From the IDE's terminal, the user can directly
1416
access all development tools of the Linux system and even install missing ones.
1517

src/docs/getting-started.md

Lines changed: 44 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,50 @@
11
# Getting Started
22

3-
Gitpod provides continuous dev environments for the development flows of common code hosting platforms.
4-
The following example shows how to use Gitpod with a source code repository.
3+
[Gitpod](https://www.gitpod.io) is an open source platform for automated and ready-to-code development environments that blends into your existing workflow.
54

6-
1. Point your browser to a GitLab, GitHub or Bitbucket repository, Pull/Merge Request, or issue, e.g.
7-
[https://gitlab.com/gitpod/spring-petclinic](https://gitlab.com/gitpod/spring-petclinic)
8-
2. Either prefix the URL in the address bar of your browser with `gitpod.io/#` (e.g.
9-
https://gitpod.io/#https://gitlab.com/gitpod/spring-petclinic) or click the _Gitpod_ button if you've installed the [Gitpod browser extension](/docs/browser-extension/).
5+
> For an overview of Gitpod you should first read [Introduction to Gitpod](/docs/).
106
11-
![prefix github URL](./images/prefix-screenshot.png)
7+
You can start using Gitpod with one or more of the following ways:
128

13-
3. On first use you will have to authorize access to your GitLab, GitHub or Bitbucket account. This is necessary so you
14-
can access your data from within Gitpod.
15-
4. Gitpod will now launch a workspace container for you in the cloud, containing a full Linux environment.
16-
It will also clone the repository, branch, or commit based on which code-hosting page you were coming from.
9+
- Use a [Prefixed URL](#prefixed-url)
10+
- Install [Browser Extension](#browser-extension)
11+
- Enable [GitLab Integration](#gitlab-integration)
12+
- Quick start using an [Example Project](#example-project) or [OSS Project](#gitpodified-open-source-project)
1713

18-
Next up you should learn about [Gitpod's IDE](/docs/ide/).
14+
## Prefixed URL
15+
16+
You can quickly open a new workspace for your project using a context URL like repository, branch, pull request, issue, or file. Just prefix the URL in the address bar of your browser with `gitpod.io/#`.
17+
18+
For example, try opening [https://gitpod.io/#https://gitlab.com/gitpod/spring-petclinic](https://gitpod.io/#https://gitlab.com/gitpod/spring-petclinic) or [https://gitlab.com/gitpod/spring-petclinic/-/merge_requests/2](https://gitlab.com/gitpod/spring-petclinic/-/merge_requests/2).
19+
20+
[Learn more &rarr;](/docs/context-urls/)
21+
22+
## Browser Extension
23+
24+
For convenience, we've made a browser extension that works with Google Chrome, Mozilla Firefox, and Safari. The extension adds a Gitpod button on every project and branch across GitLab, GitHub, and Bitbucket so you can easily open a new workspace for any existing project.
25+
26+
[Learn more &rarr;](/docs/browser-extension/)
27+
28+
## GitLab Integration
29+
30+
GitLab comes with a native Gitpod which is enabled by default for GitLab.com. To use the GitLab integration, you need to enable it from your [user preferences](https://gitlab.com/-/profile/preferences) at GitLab. Then you can choose to open a Gitpod workspace as an alternative to the GitLab Web IDE directly from GitLab for any existing project.
31+
32+
[Learn more &rarr;](/docs/gitlab-integration/)
33+
34+
## Example Project
35+
36+
We've alrelay added Gitpod configuration for some example or existing projects.
37+
38+
You can pick any of the example projects listed under [Languages & Frameworks](https://www.gitpod.io/docs/languages-and-frameworks/).
39+
40+
For example, try opening [Vuepress](https://gitpod.io/#https://github.com/vuejs/vuepress) or a [Java with Spring Boot](https://gitpod.io/#https://github.com/gitpod-io/spring-petclinic) example.
41+
42+
## Gitpodified Open Source Projects {#gitpodified-open-source-project}
43+
44+
We all know that setting up a local dev environment for a contribution to your favourite OSS project can be daunting. Luckily there are already numerous projects out there that gitpodified their repositories allowing everyone to contribute with a single click. With [contribute.dev](https://contribute.dev/) we even made a website to list them.
45+
46+
For example try opening some of our favorite OSS projects out there:
47+
- [freeCodeCamp](https://gitpod.io/#https://github.com/freeCodeCamp/freeCodeCamp)
48+
- [Prometheus](https://gitpod.io/#https://github.com/prometheus/prometheus)
49+
- [GitLab](https://gitpod.io/#https://gitlab.com/gitlab-org/gitlab)
50+
- [Forem](https://gitpod.io/#https://github.com/thepracticaldev/dev.to) powering dev.to

0 commit comments

Comments
 (0)