From 9cfb652b291aa094c4360acb540f2eebee9f9550 Mon Sep 17 00:00:00 2001
From: Ofer Shaal <oshaal@phase2technology.com>
Date: Tue, 1 Feb 2022 16:53:49 -0500
Subject: [PATCH] Adding Gitpod support (#661)

* Adding Gitpod setup

* remove specifying vscode extensions in gitpod

* Allow ports 4000-4999

* Make local dev env instructions the first option
---
 .gitpod.yml                    | 28 ++++++++++++++++++++++++++++
 docs/resources/contributing.md |  3 +++
 2 files changed, 31 insertions(+)
 create mode 100644 .gitpod.yml

diff --git a/.gitpod.yml b/.gitpod.yml
new file mode 100644
index 00000000..053d74ce
--- /dev/null
+++ b/.gitpod.yml
@@ -0,0 +1,28 @@
+tasks:
+  - init: npm install && npm run build
+    command: npm run start
+
+ports:
+  - port: 3001
+    onOpen: ignore
+  - port: 4000-4999
+    onOpen: open-preview
+
+github:
+  prebuilds:
+    # enable for the master/default branch (defaults to true)
+    master: true
+    # enable for all branches in this repo (defaults to false)
+    branches: true
+    # enable for pull requests coming from this repo (defaults to true)
+    pullRequests: true
+    # enable for pull requests coming from forks (defaults to false)
+    pullRequestsFromForks: true
+    # add a check to pull requests (defaults to true)
+    addCheck: true
+    # add a "Review in Gitpod" button as a comment to pull requests (defaults to false)
+    addComment: false
+    # add a "Review in Gitpod" button to the pull request's description (defaults to false)
+    addBadge: true
+    # add a label once the prebuild is ready to pull requests (defaults to false)
+    addLabel: true
diff --git a/docs/resources/contributing.md b/docs/resources/contributing.md
index 6d503007..50878c38 100644
--- a/docs/resources/contributing.md
+++ b/docs/resources/contributing.md
@@ -90,6 +90,9 @@ npm run start
 
 After the initial build, a browser will open automatically to a local version of the docs. The documentation is powered by Docsify, which uses raw markdown files to generate pages on the fly.
 
+Alternatively, you can use Gitpod for a dev environment in the cloud (no local setup is needed, everything is done through your browser)
+[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/shoelace-style/shoelace)
+
 ### Creating New Components
 
 To scaffold a new component, run the following command, replacing `sl-tag-name` with the desired tag name.