From a53f8d8a7df056aeb14af2e8a19d167d33f5fea2 Mon Sep 17 00:00:00 2001 From: kernelpanic77 Date: Thu, 6 Oct 2022 16:38:57 +0530 Subject: [PATCH 1/8] added contributing.md file to assist new contributors Signed-off-by: kernelpanic77 --- docs/CONTRIBUTING.md | 213 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 213 insertions(+) create mode 100644 docs/CONTRIBUTING.md diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md new file mode 100644 index 000000000..cf0d0385e --- /dev/null +++ b/docs/CONTRIBUTING.md @@ -0,0 +1,213 @@ +# Contributing to Devworkspace-Operator + +Hello there! thank you for choosing to the contributing to devfile/devworkspace-operator. Navigate through the following to understand more about contributing here. + +- [Contributing to Devworkspace-Operator](#contributing-to-devworkspace-operator) +- [Before You Get Started](#before-you-get-started) + - [Code of Conduct](#code-of-conduct) + - [For Newcomers](#for-newcomers) +- [How to Contribute](#how-to-contribute) + - [Set up your Local Development Environment](#set-up-your-local-development-environment) + - [Testing Changes](#testing-changes) + - [Signing-off on Commits](#signing-off-on-commits) + (#testing-your-changes) + - [Signing-off on Commits](#signing-off-on-commits) + +# Before You Get Started + +## Code of Conduct + +## For Newcomers + +# How to Contribute + + + +## Set up your Local Development Environment + +Follow the following instructions to start contributing. + +**1.** Fork [this](https://github.com/devfile/devworkspace-operator) repository. + +**2.** Clone your forked copy of the project. + +``` +git clone https://github.com//devworkspace-operator.git +``` + +**3.** Navigate to the project directory. + +``` +cd devworkspace-operator +``` + +**4.** Add a reference(remote) to the original repository. + +``` +git remote add upstream https://github.com/devfile/devworkspace-operator.git +``` + +**5.** Check the remotes for this repository. + +``` +git remote -v +``` + +**6.** Always take a pull from the upstream repository to your master branch to keep it at par with the main project (updated repository). + +``` +git pull upstream master +``` + +**7.** Create a new branch. + +``` +git checkout -b +``` + +**8.** Start the minikube cluster. + +``` +minikube start +``` + +**9.** Enable the ingress add-on for your minikube cluster. + +``` +minikube addons enable ingress +``` + +**10.** Set the namespace environment variable for the development environment to avoid changes inside the default namespace. + +``` +export NAMESPACE="devworkspace-controller" +``` + +**11.** Install the kubernetes certificate management controller to generate and manage TLS certificates for your cluster. + +``` +make install cert-manager. +``` + +**12.** Install the dependencies for running the devworkspace-operator in your cluster. + +``` +make install +``` + +**13.** Scale down the replicas of pods to 0. + +``` +kubectl patch deployment/devworkspace-controller-manager --patch "{\"spec\":{\"replicas\":0}}" -n $NAMESPACE +``` + +**14.** Run the devworkspace-operator. + +``` +make run +``` + +This will run the devworkspace-controller in your local cluster (minikube/openshift). + +**15.** Make your changes in the new branch and trach the changes. + +``` +git add . +``` + +**16.** Commit your changes. To contribute to this project, you must agree to the [Developer Certificate of Origin (DCO)](#signing-off-on-commits) for each commit you make. + +``` +git commit --signoff -m "" +``` + +or you could go with the shorter format for the same, as shown below. + +``` +git commit -s -m "" +``` + +**17.** While you are working on your branch, other developers may update the `master` branch with their branch. This action means your branch is now out of date with the `master` branch and missing content. So to fetch the new changes, follow along: + +``` +git checkout master +git fetch origin master +git merge upstream/master +git push origin +``` + +Now you need to merge the `master` branch into your branch. This can be done in the following way: + +``` +git checkout +git merge master +``` + +**18.** Push the committed changes in your feature branch to your remote repo. + +``` +git push -u origin +``` + +## Testing Changes + +## Signing-off on Commits + +To contribute to this project, you must agree to the **Developer Certificate of +Origin (DCO)** for each commit you make. The DCO is a simple statement that you, +as a contributor, have the legal right to make the contribution. + +See the [DCO](https://developercertificate.org) file for the full text of what you must agree to +and how it works [here](https://github.com/probot/dco#how-it-works). +To signify that you agree to the DCO for contributions, you simply add a line to each of your +git commit messages: + +``` +Signed-off-by: John Doe +``` + +**Note:** you don't have to manually include this line on your commits, git does that for you as shown below: + +``` +$ git commit -s -m “my commit message w/signoff” +``` + +In most cases, git automatically adds the signoff to your commit with the use of +`-s` or `--signoff` flag to `git commit`. You must use your real name and a reachable email +address (sorry, no pseudonyms or anonymous contributions). + +To ensure all your commits are signed, you may choose to add this alias to your global `.gitconfig`: + +_~/.gitconfig_ + +``` +[alias] + amend = commit -s --amend + cm = commit -s -m + commit = commit -s +``` From 079f79bc5b29faaa267438f9d0dda08c41284c22 Mon Sep 17 00:00:00 2001 From: Ishan Shanware Date: Fri, 13 Jan 2023 22:29:09 +0530 Subject: [PATCH 2/8] Update docs/CONTRIBUTING.md Co-authored-by: Angel Misevski --- docs/CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index cf0d0385e..27fa57dca 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -1,6 +1,6 @@ # Contributing to Devworkspace-Operator -Hello there! thank you for choosing to the contributing to devfile/devworkspace-operator. Navigate through the following to understand more about contributing here. +Hello there! Thank you for choosing to the contributing to devfile/devworkspace-operator. Navigate through the following to understand more about contributing here. - [Contributing to Devworkspace-Operator](#contributing-to-devworkspace-operator) - [Before You Get Started](#before-you-get-started) From b171c164cbf11ea4e02dfaf92053e37b43f66cff Mon Sep 17 00:00:00 2001 From: Ishan Shanware Date: Fri, 13 Jan 2023 22:29:24 +0530 Subject: [PATCH 3/8] Update docs/CONTRIBUTING.md Co-authored-by: Angel Misevski --- docs/CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index 27fa57dca..7e7689f02 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -2,7 +2,7 @@ Hello there! Thank you for choosing to the contributing to devfile/devworkspace-operator. Navigate through the following to understand more about contributing here. -- [Contributing to Devworkspace-Operator](#contributing-to-devworkspace-operator) +- [Contributing to the DevWorkspace Operator](#contributing-to-devworkspace-operator) - [Before You Get Started](#before-you-get-started) - [Code of Conduct](#code-of-conduct) - [For Newcomers](#for-newcomers) From a370293b8ad4d8cebf8033bb77f26167cf1f22e6 Mon Sep 17 00:00:00 2001 From: kernelpanic77 Date: Thu, 6 Oct 2022 16:38:57 +0530 Subject: [PATCH 4/8] added contributing.md file to assist new contributors Signed-off-by: kernelpanic77 --- docs/CONTRIBUTING.md | 213 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 213 insertions(+) create mode 100644 docs/CONTRIBUTING.md diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md new file mode 100644 index 000000000..cf0d0385e --- /dev/null +++ b/docs/CONTRIBUTING.md @@ -0,0 +1,213 @@ +# Contributing to Devworkspace-Operator + +Hello there! thank you for choosing to the contributing to devfile/devworkspace-operator. Navigate through the following to understand more about contributing here. + +- [Contributing to Devworkspace-Operator](#contributing-to-devworkspace-operator) +- [Before You Get Started](#before-you-get-started) + - [Code of Conduct](#code-of-conduct) + - [For Newcomers](#for-newcomers) +- [How to Contribute](#how-to-contribute) + - [Set up your Local Development Environment](#set-up-your-local-development-environment) + - [Testing Changes](#testing-changes) + - [Signing-off on Commits](#signing-off-on-commits) + (#testing-your-changes) + - [Signing-off on Commits](#signing-off-on-commits) + +# Before You Get Started + +## Code of Conduct + +## For Newcomers + +# How to Contribute + + + +## Set up your Local Development Environment + +Follow the following instructions to start contributing. + +**1.** Fork [this](https://github.com/devfile/devworkspace-operator) repository. + +**2.** Clone your forked copy of the project. + +``` +git clone https://github.com//devworkspace-operator.git +``` + +**3.** Navigate to the project directory. + +``` +cd devworkspace-operator +``` + +**4.** Add a reference(remote) to the original repository. + +``` +git remote add upstream https://github.com/devfile/devworkspace-operator.git +``` + +**5.** Check the remotes for this repository. + +``` +git remote -v +``` + +**6.** Always take a pull from the upstream repository to your master branch to keep it at par with the main project (updated repository). + +``` +git pull upstream master +``` + +**7.** Create a new branch. + +``` +git checkout -b +``` + +**8.** Start the minikube cluster. + +``` +minikube start +``` + +**9.** Enable the ingress add-on for your minikube cluster. + +``` +minikube addons enable ingress +``` + +**10.** Set the namespace environment variable for the development environment to avoid changes inside the default namespace. + +``` +export NAMESPACE="devworkspace-controller" +``` + +**11.** Install the kubernetes certificate management controller to generate and manage TLS certificates for your cluster. + +``` +make install cert-manager. +``` + +**12.** Install the dependencies for running the devworkspace-operator in your cluster. + +``` +make install +``` + +**13.** Scale down the replicas of pods to 0. + +``` +kubectl patch deployment/devworkspace-controller-manager --patch "{\"spec\":{\"replicas\":0}}" -n $NAMESPACE +``` + +**14.** Run the devworkspace-operator. + +``` +make run +``` + +This will run the devworkspace-controller in your local cluster (minikube/openshift). + +**15.** Make your changes in the new branch and trach the changes. + +``` +git add . +``` + +**16.** Commit your changes. To contribute to this project, you must agree to the [Developer Certificate of Origin (DCO)](#signing-off-on-commits) for each commit you make. + +``` +git commit --signoff -m "" +``` + +or you could go with the shorter format for the same, as shown below. + +``` +git commit -s -m "" +``` + +**17.** While you are working on your branch, other developers may update the `master` branch with their branch. This action means your branch is now out of date with the `master` branch and missing content. So to fetch the new changes, follow along: + +``` +git checkout master +git fetch origin master +git merge upstream/master +git push origin +``` + +Now you need to merge the `master` branch into your branch. This can be done in the following way: + +``` +git checkout +git merge master +``` + +**18.** Push the committed changes in your feature branch to your remote repo. + +``` +git push -u origin +``` + +## Testing Changes + +## Signing-off on Commits + +To contribute to this project, you must agree to the **Developer Certificate of +Origin (DCO)** for each commit you make. The DCO is a simple statement that you, +as a contributor, have the legal right to make the contribution. + +See the [DCO](https://developercertificate.org) file for the full text of what you must agree to +and how it works [here](https://github.com/probot/dco#how-it-works). +To signify that you agree to the DCO for contributions, you simply add a line to each of your +git commit messages: + +``` +Signed-off-by: John Doe +``` + +**Note:** you don't have to manually include this line on your commits, git does that for you as shown below: + +``` +$ git commit -s -m “my commit message w/signoff” +``` + +In most cases, git automatically adds the signoff to your commit with the use of +`-s` or `--signoff` flag to `git commit`. You must use your real name and a reachable email +address (sorry, no pseudonyms or anonymous contributions). + +To ensure all your commits are signed, you may choose to add this alias to your global `.gitconfig`: + +_~/.gitconfig_ + +``` +[alias] + amend = commit -s --amend + cm = commit -s -m + commit = commit -s +``` From 14350652de26836bcf70f426afa2d915d9dd79ca Mon Sep 17 00:00:00 2001 From: Ishan Shanware Date: Fri, 13 Jan 2023 22:29:09 +0530 Subject: [PATCH 5/8] Update docs/CONTRIBUTING.md Co-authored-by: Angel Misevski --- docs/CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index cf0d0385e..27fa57dca 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -1,6 +1,6 @@ # Contributing to Devworkspace-Operator -Hello there! thank you for choosing to the contributing to devfile/devworkspace-operator. Navigate through the following to understand more about contributing here. +Hello there! Thank you for choosing to the contributing to devfile/devworkspace-operator. Navigate through the following to understand more about contributing here. - [Contributing to Devworkspace-Operator](#contributing-to-devworkspace-operator) - [Before You Get Started](#before-you-get-started) From 654a59f6c6f05c1882b4109f782e732644f63036 Mon Sep 17 00:00:00 2001 From: Ishan Shanware Date: Fri, 13 Jan 2023 22:29:24 +0530 Subject: [PATCH 6/8] Update docs/CONTRIBUTING.md Co-authored-by: Angel Misevski --- docs/CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index 27fa57dca..7e7689f02 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -2,7 +2,7 @@ Hello there! Thank you for choosing to the contributing to devfile/devworkspace-operator. Navigate through the following to understand more about contributing here. -- [Contributing to Devworkspace-Operator](#contributing-to-devworkspace-operator) +- [Contributing to the DevWorkspace Operator](#contributing-to-devworkspace-operator) - [Before You Get Started](#before-you-get-started) - [Code of Conduct](#code-of-conduct) - [For Newcomers](#for-newcomers) From 0c0520a89bc582ea9ddce54d6d079884fb90cb9e Mon Sep 17 00:00:00 2001 From: kernelpanic77 Date: Wed, 25 Jan 2023 01:44:41 +0530 Subject: [PATCH 7/8] updated contributing.md Signed-off-by: kernelpanic77 --- docs/CONTRIBUTING.md | 155 ++++++++++--------------------------------- 1 file changed, 34 insertions(+), 121 deletions(-) diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index 7e7689f02..bdb1c0670 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -2,57 +2,21 @@ Hello there! Thank you for choosing to the contributing to devfile/devworkspace-operator. Navigate through the following to understand more about contributing here. -- [Contributing to the DevWorkspace Operator](#contributing-to-devworkspace-operator) -- [Before You Get Started](#before-you-get-started) - - [Code of Conduct](#code-of-conduct) - - [For Newcomers](#for-newcomers) +- [Contributing to Devworkspace-Operator](#contributing-to-devworkspace-operator) - [How to Contribute](#how-to-contribute) - - [Set up your Local Development Environment](#set-up-your-local-development-environment) + - [Set up your Development Environment](#set-up-your-development-environment) + - [Running the controller locally.](#running-the-controller-locally) - [Testing Changes](#testing-changes) + - [Test run the controller](#test-run-the-controller) + - [Developing Webhooks](#developing-webhooks) - [Signing-off on Commits](#signing-off-on-commits) - (#testing-your-changes) - - [Signing-off on Commits](#signing-off-on-commits) - -# Before You Get Started - -## Code of Conduct - -## For Newcomers # How to Contribute +To contribute to the devworkspace-operator project, developers should follow the fork and pull request workflow. +## Set up your Development Environment - - -## Set up your Local Development Environment -Follow the following instructions to start contributing. - -**1.** Fork [this](https://github.com/devfile/devworkspace-operator) repository. +**1.** Fork [Devworkspace operator](https://github.com/devfile/devworkspace-operator) repository. **2.** Clone your forked copy of the project. @@ -60,130 +24,79 @@ Follow the following instructions to start contributing. git clone https://github.com//devworkspace-operator.git ``` -**3.** Navigate to the project directory. - -``` -cd devworkspace-operator -``` - -**4.** Add a reference(remote) to the original repository. - -``` -git remote add upstream https://github.com/devfile/devworkspace-operator.git -``` - -**5.** Check the remotes for this repository. - -``` -git remote -v -``` - -**6.** Always take a pull from the upstream repository to your master branch to keep it at par with the main project (updated repository). +#### Running the controller locally. -``` -git pull upstream master -``` +In the steps listed below, we set up the development environment using a minikube cluster. -**7.** Create a new branch. - -``` -git checkout -b -``` - -**8.** Start the minikube cluster. +**1.** Start the minikube cluster. ``` minikube start ``` -**9.** Enable the ingress add-on for your minikube cluster. +**2.** Enable the ingress add-on for your minikube cluster. ``` minikube addons enable ingress ``` -**10.** Set the namespace environment variable for the development environment to avoid changes inside the default namespace. +**3.** Set the namespace environment variable for the development environment to avoid changes inside the default namespace. ``` export NAMESPACE="devworkspace-controller" ``` -**11.** Install the kubernetes certificate management controller to generate and manage TLS certificates for your cluster. +**4.** Install the kubernetes certificate management controller to generate and manage TLS certificates for your cluster. ``` -make install cert-manager. +make install_cert_manager. ``` +Please note that the above step is not specific to minikube. The cert-manager is required for all deployments on kubernetes. + -**12.** Install the dependencies for running the devworkspace-operator in your cluster. +**5.** Install the dependencies for running the devworkspace-operator in your cluster. ``` make install ``` -**13.** Scale down the replicas of pods to 0. +**6.** Scale down the replicas controller-manager pods to 0. ``` kubectl patch deployment/devworkspace-controller-manager --patch "{\"spec\":{\"replicas\":0}}" -n $NAMESPACE ``` -**14.** Run the devworkspace-operator. +**7.** Run the devworkspace-operator. ``` make run ``` -This will run the devworkspace-controller in your local cluster (minikube/openshift). +This will run the devworkspace-controller in your local system. -**15.** Make your changes in the new branch and trach the changes. - -``` -git add . -``` - -**16.** Commit your changes. To contribute to this project, you must agree to the [Developer Certificate of Origin (DCO)](#signing-off-on-commits) for each commit you make. - -``` -git commit --signoff -m "" -``` +**8.** Make your changes in the new branch and test the changes. -or you could go with the shorter format for the same, as shown below. -``` -git commit -s -m "" -``` - -**17.** While you are working on your branch, other developers may update the `master` branch with their branch. This action means your branch is now out of date with the `master` branch and missing content. So to fetch the new changes, follow along: - -``` -git checkout master -git fetch origin master -git merge upstream/master -git push origin -``` - -Now you need to merge the `master` branch into your branch. This can be done in the following way: +## Testing Changes -``` -git checkout -git merge master -``` +#### Test run the controller -**18.** Push the committed changes in your feature branch to your remote repo. +**1.** Take a look samples devworkspace configuration in `./samples` folder. +**2.** Apply any of them by executing `kubectl apply -f ./samples/theia-latest.yaml -n `. +**3.** As soon as devworkspace is started you're able to get IDE url by executing `kubectl get devworkspace -n ` -``` -git push -u origin -``` -## Testing Changes +#### Developing Webhooks +**1.** Make a change to the webhook. +**2.** Ensure the `DWO_IMG` environment variable points to your container image repository, eg. export `DWO_IMG=quay.io/aobuchow/dwo-webhook:next`. +**3.** Run `make docker restart` (assuming DWO is already deployed to the cluster, otherwise make docker install). +Wait for the webhook deployment to update with your image that contains your latest changes. ## Signing-off on Commits -To contribute to this project, you must agree to the **Developer Certificate of -Origin (DCO)** for each commit you make. The DCO is a simple statement that you, -as a contributor, have the legal right to make the contribution. +To contribute to this project, you must agree to the **code fo conduct** for each commit you make. -See the [DCO](https://developercertificate.org) file for the full text of what you must agree to -and how it works [here](https://github.com/probot/dco#how-it-works). +See the [code of conduct](https://github.com/devfile/api/blob/main/CODE_OF_CONDUCT.md) file for the full text of what you must agree to. To signify that you agree to the DCO for contributions, you simply add a line to each of your git commit messages: From 614092fecf050a7fb772fd979d2e185f9f9ab86f Mon Sep 17 00:00:00 2001 From: Ishan Shanware Date: Wed, 8 Feb 2023 01:06:02 +0530 Subject: [PATCH 8/8] changes for contributing.md 'testing controller' --- docs/CONTRIBUTING.md | 39 ++++++++++++++++++++++++--------------- 1 file changed, 24 insertions(+), 15 deletions(-) diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index bdb1c0670..7be773ab4 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -1,8 +1,8 @@ -# Contributing to Devworkspace-Operator +# Contributing to DevWorkspace Operator -Hello there! Thank you for choosing to the contributing to devfile/devworkspace-operator. Navigate through the following to understand more about contributing here. +Hello there! Thank you for choosing to contribute to DevWorkspace Operator. Navigate through the following table of contents to learn more about contributing to the project. -- [Contributing to Devworkspace-Operator](#contributing-to-devworkspace-operator) +- [Contributing to DevWorkspace Operator](#contributing-to-devworkspace-operator) - [How to Contribute](#how-to-contribute) - [Set up your Development Environment](#set-up-your-development-environment) - [Running the controller locally.](#running-the-controller-locally) @@ -12,11 +12,11 @@ Hello there! Thank you for choosing to the contributing to devfile/devworkspace- - [Signing-off on Commits](#signing-off-on-commits) # How to Contribute -To contribute to the devworkspace-operator project, developers should follow the fork and pull request workflow. +To contribute to the DevWorkspace Operator project, developers should follow the [fork](https://docs.github.com/en/get-started/quickstart/fork-a-repo) and [pull request workflow](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork). ## Set up your Development Environment -**1.** Fork [Devworkspace operator](https://github.com/devfile/devworkspace-operator) repository. +**1.** Fork [devworkspace-operator](https://github.com/devfile/devworkspace-operator) repository. **2.** Clone your forked copy of the project. @@ -26,7 +26,7 @@ git clone https://github.com//devworkspace-operator.git #### Running the controller locally. -In the steps listed below, we set up the development environment using a minikube cluster. +In the steps listed below, we set up the development environment using a [minikube cluster](https://minikube.sigs.k8s.io/docs/start/). **1.** Start the minikube cluster. @@ -51,10 +51,10 @@ export NAMESPACE="devworkspace-controller" ``` make install_cert_manager. ``` -Please note that the above step is not specific to minikube. The cert-manager is required for all deployments on kubernetes. +Please note that the above step is not specific to minikube. The cert-manager is required for all deployments on Kubernetes. -**5.** Install the dependencies for running the devworkspace-operator in your cluster. +**5.** Install the dependencies for running the DevWorkspace Operator in your cluster. ``` make install @@ -72,7 +72,7 @@ kubectl patch deployment/devworkspace-controller-manager --patch "{\"spec\":{\"r make run ``` -This will run the devworkspace-controller in your local system. +This will run the devworkspace-controller on your local system. **8.** Make your changes in the new branch and test the changes. @@ -81,20 +81,29 @@ This will run the devworkspace-controller in your local system. #### Test run the controller -**1.** Take a look samples devworkspace configuration in `./samples` folder. -**2.** Apply any of them by executing `kubectl apply -f ./samples/theia-latest.yaml -n `. -**3.** As soon as devworkspace is started you're able to get IDE url by executing `kubectl get devworkspace -n ` +**1.** Take a look samples DevWorkspaces in the `./samples` directory. If you are uncertain on which one to try, use `theia-latest.yaml`. +**2.** Apply a sample by executing `kubectl apply -f ./samples/ -n $NAMESPACE`. For instance, `kubectl apply -f ./samples/theia-latest.yaml -n $NAMESPACE`. + +**3.** As soon as devworkspace is started you're able to get IDE url by executing `kubectl get devworkspace -n `. + +**4.** To check for the DevWorkspace status, execute `kubectl get dw -n $NAMESPACE -w`. + +**5.** As soon as the DevWorkspace is started, an IDE url will appear from the output of `kubectl get dw -n $NAMESPACE -w`. This assumes that the DevWorkspace sample you chose includes an IDE. #### Developing Webhooks **1.** Make a change to the webhook. -**2.** Ensure the `DWO_IMG` environment variable points to your container image repository, eg. export `DWO_IMG=quay.io/aobuchow/dwo-webhook:next`. -**3.** Run `make docker restart` (assuming DWO is already deployed to the cluster, otherwise make docker install). + + +**2.** Ensure the `DWO_IMG` environment variable points to your container image repository, eg. export `DWO_IMG=quay.io//dwo-webhook:next`. + + +**3.** Run `make docker restart` (assuming DWO is already deployed to the cluster, otherwise run `make docker install`). Wait for the webhook deployment to update with your image that contains your latest changes. ## Signing-off on Commits -To contribute to this project, you must agree to the **code fo conduct** for each commit you make. +To contribute to this project, you must agree to the **code of conduct** for each commit you make. See the [code of conduct](https://github.com/devfile/api/blob/main/CODE_OF_CONDUCT.md) file for the full text of what you must agree to. To signify that you agree to the DCO for contributions, you simply add a line to each of your