Skip to content
This repository was archived by the owner on Nov 28, 2022. It is now read-only.

Commit d81aec9

Browse files
sishidasghung
authored andcommitted
Adding example to updating version info. (#125)
* Adding info about updating Codewind Signed-off-by: Sarah Ishida <sishida@us.ibm.com> * Edit instructions based on feedback Signed-off-by: Sarah Ishida <sishida@us.ibm.com> * Edits to step 2 based on feedback Signed-off-by: Sarah Ishida <sishida@us.ibm.com> * Adding example to Codewind updating info Signed-off-by: Sarah Ishida <sishida@us.ibm.com>
1 parent 14ac393 commit d81aec9

File tree

3 files changed

+27
-1
lines changed

3 files changed

+27
-1
lines changed

docs/_documentations/installoncloud.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ To setup a Codewind-ready install of Che, follow these instructions. Alternative
2222
4. [Setting up other Kubernetes](#setting-up-other-kubernetes)
2323
5. [After installing Che](#after-installing-che)
2424
6. [Creating the Codewind workspace](#creating-the-codewind-workspace)
25+
7. [Updating the version](#updating-the-version)
2526

2627
## Prerequisites
2728
- Set up the PersistentVolume (PV) with either Network File System (NFS) or GlusterFS.
@@ -58,7 +59,6 @@ If the Che operator was not used to install Eclipse Che, follow these steps inst
5859
4. From the [Codewind Che plug-in repository](https://github.com/eclipse/codewind-che-plugin) run the `kubectl apply -f setup/install_che/codewind-clusterrole.yaml` command to create a cluster role with the required permission.
5960
5. From the [Codewind Che plug-in repository](https://github.com/eclipse/codewind-che-plugin) run the `kubectl apply -f setup/install_che/codewind-rolebinding.yaml` command.
6061

61-
6262
### Enable privileged and root containers to run
6363
Codewind is currently required to run as privileged (as it builds container images) and as root. Run the following commands to enable that functionality:
6464
1. Enter `oc adm policy add-scc-to-group privileged system:serviceaccounts:eclipse-che` to enable privileged containers
@@ -196,3 +196,6 @@ Go to **View**>**Find Command…**>**Codewind: Build**.
196196
197197
- Alternative instructions:
198198
- Enter the following command: `curl -k -H "Content-Type: application/json" -X POST https://codewind-release:9191/api/v1/projects/8801a6d0-7805-11e9-b22f-19482c5ffbd6/build -d '{"action": "build"}'`
199+
200+
## Updating the version
201+
Restart the Codewind workspace in Che. Che automatically pulls the newest version of Codewind and the Theia extension.

docs/_documentations/mdt-eclipse-installinfo.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,18 @@ When the installation is complete, the extension is ready to use, and you are pr
2727

2828
Codewind creates the `~/codewind-workspace` folder to contain your projects. On Windows, you can find the workspace at the `C:\codewind-workspace` folder. You can open the `codewind-workspace` or a project within the workspace as your Eclipse workspace. For more information, see [Getting started: Codewind for Eclipse](mdteclipsegettingstarted.html).
2929

30+
## Updating the Codewind plug-in
31+
Starting with Codewind version 0.3.0, you can update the Codewind Eclipse plug-in without uninstalling the extension. For example, you can update Codewind 0.3.0 to Codewind 0.3.1.
32+
1. From Eclipse, go to **Help**>**About Eclipse IDE**.
33+
2. Click **Installation details**.
34+
3. To look for the latest release, highlight **Codewind tech preview** and click **Update...**.
35+
4. Select the latest version and click **Next**.
36+
5. Review the license and click **Finish**.
37+
6. Click **Restart Now** to refresh Codewind to the latest version.
38+
7. After Codewind restarts, go to the **Codewind Explorer** view. Double-click **Codewind** to update it to the latest version.
39+
8. Click **OK** in the **Codewind Update** window that states that the older version of Codewind will be removed, and the newer version will be started.
40+
9. After Codewind updates, the **Codewind Explorer** view appears with your projects.
41+
3042
## Removing containers and images
3143
To remove Codewind, see [Uninstalling Codewind from Eclipse](mdteclipseuninstall.html).
3244

docs/_documentations/mdt-vsc-installinfo.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,17 @@ When the installation is complete, the extension is ready to use, and you are pr
2929

3030
Codewind creates the `~/codewind-workspace` folder to contain your projects. On Windows, you can find the workspace at the `C:\codewind-workspace` folder. You can open the `codewind-workspace` or a project within the workspace as your VS Code workspace. For more information, see [Getting started: Codewind for VS Code](mdt-vsc-getting-started.html).
3131

32+
## Updating the Codewind plug-in
33+
Starting with Codewind version 0.3.0, you can update your Codewind plug-in without uninstalling the extension. For example, you can update Codewind 0.3.0 to Codewind 0.3.1.
34+
1. Go to the **Extensions** view in VS Code.
35+
2. Search for the latest Codewind version in the Marketplace.
36+
3. Install the latest version of Codewind. Then, reload Codewind.
37+
4. Go to the **Explorer** view in VS Code.
38+
5. Depending on the current status of Codewind, one of two messages appear:
39+
- If the images from a previous version or release of Codewind are installed on the system, but Codewind is not running, a message asks you to install the most recent images. Click **OK** to start the download.
40+
- If an older version of Codewind is installed and running, a message asks you to update the older version. Click **OK**, and Codewind stops automatically, and new images begin to download.
41+
5. Wait for the Codewind installation to complete. Codewind starts and is ready to use.
42+
3243
## Removing containers and images
3344
To remove Codewind, see [Uninstalling Codewind from VS Code](mdt-vsc-uninstall.html).
3445

0 commit comments

Comments
 (0)