Add new section in README.md

Signed-off-by: Mario Loriedo <[email protected]>
devfile · Nov 11, 2024 · 298d378 · 298d378
1 parent 2303e13
commit 298d378
Show file tree

Hide file tree

Showing 8 changed files with 35 additions and 3 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -33,4 +33,4 @@ Owners of the repository will watch out for and review new PRs.
 
 If comments have been given in a review, they have to be addressed before merging.
 
-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.
+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.
diff --git a/README.md b/README.md
@@ -1,10 +1,42 @@
-# Dev Workspace Operator
+<p align="center"><img alt="DevWorkspace operator" src="./img/logo.png" width="150px" /></p>
+
+# DevWorkspace Operator
 
 [![codecov](https://codecov.io/gh/devfile/devworkspace-operator/branch/main/graph/badge.svg)](https://codecov.io/gh/devfile/devworkspace-operator)
 [![OpenSSF Best Practices](https://www.bestpractices.dev/projects/8258/badge)](https://www.bestpractices.dev/projects/8258)
 [![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/devfile/devworkspace-operator/badge)](https://securityscorecards.dev/viewer/?uri=github.com/devfile/devworkspace-operator)
 
-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.
+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.
+
+## What is the DevWorkspace Operator?
+
+A [Kubernetes Operator](https://kubernetes.io/docs/concepts/extend-kubernetes/operator/) to run **fast**, **repeatable**
+and **scalable** Cloud Development Environments.
+
+[Install it](#deploying-devworkspace-operator) and apply a DevWorkspace to create a Cloud Development Environment:<br/>
+![dw apply demo](img/apply-demo.gif)
+
+Get the Cloud Developent Environment URI:<br/>
+![dw get demo](img/get-demo.gif)
+
+Open the IDE:<br/>
+| Visual Studio Code  | JetBrains IntelliJ |
+| ------------- | ------------- |
+| ![vscode](img/vscode.png) | ![intellij](img/intellij.png) |
+
+## Example
+
+Here is a sample DevWorkspace to provision a Cloud Development Environment for the project
+[github.com/l0rd/outyet](https://github.com/l0rd/outyet) with Visual Studio Code as editor and 
+`quay.io/devfile/universal-developer-image:ubi8-latest` as the development tooling container image.<br/>
+
+The **template section of a DevWorkspace** is actually [a Devfile](https://devfile.io/docs/2.3.0/what-is-a-devfile): the 
+`spec.template` schema matches the [Devfile schema](https://devfile.io/docs/2.3.0/devfile-schema).
+
+**Contributions** are extra components that are added on top of the template. Contributions are used to inject editors 
+such as Visual Studio Code and JetBrains.
+
+![devworkspace](img/devworkspace.png)
 
 ## Configuration
 

diff --git a/img/apply-demo.gif b/img/apply-demo.gif
diff --git a/img/devworkspace.png b/img/devworkspace.png
diff --git a/img/get-demo.gif b/img/get-demo.gif
diff --git a/img/intellij.png b/img/intellij.png
diff --git a/img/logo.png b/img/logo.png
diff --git a/img/vscode.png b/img/vscode.png
Original file line number	Diff line number	Diff line change
Expand Up		@@ -33,4 +33,4 @@ Owners of the repository will watch out for and review new PRs.

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

		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.
		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.