Skip to content

Commit 73784d6

Browse files
l0rddkwon17
authored andcommitted
Add new section in README.md
Signed-off-by: Mario Loriedo <[email protected]>
1 parent 10faaa7 commit 73784d6

File tree

8 files changed

+35
-3
lines changed

8 files changed

+35
-3
lines changed

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,4 +33,4 @@ Owners of the repository will watch out for and review new PRs.
3333

3434
If comments have been given in a review, they have to be addressed before merging.
3535

36-
After addressing review comments, don’t forget to add a comment in the PR afterward, so everyone gets notified by Github and knows to re-review.
36+
After addressing review comments, don’t forget to add a comment in the PR afterward, so everyone gets notified by Github and knows to re-review.

README.md

Lines changed: 34 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,42 @@
1-
# Dev Workspace Operator
1+
<p align="center"><img alt="DevWorkspace operator" src="./img/logo.png" width="150px" /></p>
2+
3+
# DevWorkspace Operator
24

35
[![codecov](https://codecov.io/gh/devfile/devworkspace-operator/branch/main/graph/badge.svg)](https://codecov.io/gh/devfile/devworkspace-operator)
46
[![OpenSSF Best Practices](https://www.bestpractices.dev/projects/8258/badge)](https://www.bestpractices.dev/projects/8258)
57
[![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/devfile/devworkspace-operator/badge)](https://securityscorecards.dev/viewer/?uri=github.com/devfile/devworkspace-operator)
68

7-
Dev Workspace operator repository that contains the controller for the DevWorkspace Custom Resource. The Kubernetes API of the DevWorkspace is defined in the https://github.com/devfile/api repository.
9+
DevWorkspace operator repository that contains the controller for the DevWorkspace Custom Resource. The Kubernetes API of the DevWorkspace is defined in the https://github.com/devfile/api repository.
10+
11+
## What is the DevWorkspace Operator?
12+
13+
A [Kubernetes Operator](https://kubernetes.io/docs/concepts/extend-kubernetes/operator/) to run **fast**, **repeatable**
14+
and **scalable** Cloud Development Environments.
15+
16+
[Install it](#deploying-devworkspace-operator) and apply a DevWorkspace to create a Cloud Development Environment:<br/>
17+
![dw apply demo](img/apply-demo.gif)
18+
19+
Get the Cloud Developent Environment URI:<br/>
20+
![dw get demo](img/get-demo.gif)
21+
22+
Open the IDE:<br/>
23+
| Visual Studio Code | JetBrains IntelliJ |
24+
| ------------- | ------------- |
25+
| ![vscode](img/vscode.png) | ![intellij](img/intellij.png) |
26+
27+
## Example
28+
29+
Here is a sample DevWorkspace to provision a Cloud Development Environment for the project
30+
[github.com/l0rd/outyet](https://github.com/l0rd/outyet) with Visual Studio Code as editor and
31+
`quay.io/devfile/universal-developer-image:ubi8-latest` as the development tooling container image.<br/>
32+
33+
The **template section of a DevWorkspace** is actually [a Devfile](https://devfile.io/docs/2.3.0/what-is-a-devfile): the
34+
`spec.template` schema matches the [Devfile schema](https://devfile.io/docs/2.3.0/devfile-schema).
35+
36+
**Contributions** are extra components that are added on top of the template. Contributions are used to inject editors
37+
such as Visual Studio Code and JetBrains.
38+
39+
![devworkspace](img/devworkspace.png)
840

941
## Configuration
1042

img/apply-demo.gif

89.7 KB
Loading

img/devworkspace.png

103 KB
Loading

img/get-demo.gif

78 KB
Loading

img/intellij.png

330 KB
Loading

img/logo.png

14.7 KB
Loading

img/vscode.png

304 KB
Loading

0 commit comments

Comments
 (0)