Merge pull request #144 from software-engineering-project-org/renameStages

#refactor Full rename of STAGES to Deployment-Variants XX

Author: cpotter302

README.md

@@ -3,10 +3,9 @@
 ##  LAD: Leda App Deployer – an Eclipse Leda Extension for Visual Studio Code
 
 
-LAD facilitates the installation of an Eclipse Velocitas App on a target device running Eclipse Leda (with Kanto). With LAD, three different deployment options called "STAGES" are selectable, to save time during Vehicle App development.
+LAD facilitates the installation of an Eclipse Velocitas App on a target device running Eclipse Leda (with Kanto). With LAD, three different deployment options called "Deployment-Variants" are selectable, to save time during Vehicle App development.
 
-
-**Important NOTE:** The base requirement is to have one (or many) target device(s) which can be accessed from this source device via SSH. Each STAGE requires configurations on the source and/or the target system, which is described in the prerequisites of each STAGE. The plugin expects that Leda is running as Operating System on the target device. If you wish to use the plugin for deployment on a different operating system and not use Leda, refer to "Prerequisites for Plugin Usage on different Operating Systems (without Leda)"
+**Important NOTE:** The base requirement is to have one (or many) target device(s) which can be accessed from this source device via SSH. Each Deployment-Variant requires configurations on the source and/or the target system, which is described in the prerequisites of each Deployment-Variant. If you with to use the plugin for deployment on a different operating system and not use Leda, refer to "Prerequisites for Plugin Usage on different Operating Systems (without Leda)"
 
 ## Install the Extension in Visual Studio Code
 LAD is not published on the official Marketplace of Visual Studio Code by now. You need to manually install the Extension in Visual Studio Code by following these simple steps:
@@ -29,13 +28,13 @@ If code is not present, do the following to install it:
 	
 After successful installation, LAD is now visible in Visual Studio Code as an Extension button that looks like a target ◎.
 
-##  Three different Ways (called "STAGES") to deploy your Application
+##  Three different Ways (called "Deployment-Variants") to deploy your Application
 
-###  STAGE 1: The Remote Build
+###  Deployment-Variant 01: The Remote Build
 
 **Description:**
 
-Use this STAGE to install Velocitas App images on a target device from a remote source. Images refer to the available images in the GitHub repositories' registry (ghcr) your application is pulled from. The target system automatically downloads the specified image from the remote GitHub Repository with the help of LAD. You can choose between the different image releases available for your Repository via dropdown.
+Use this Deployment-Variant to install Velocitas App images on a target device from a remote source. Images refer to the available images in the GitHub repositories' registry (ghcr) your application is pulled from. The target system automatically downloads the specified image from the remote GitHub Repository with the help of LAD. You can choose between the different image releases available for your Repository via dropdown.
 
 **Prerequisites:**
 
@@ -46,7 +45,7 @@ Use this STAGE to install Velocitas App images on a target device from a remote
 
 **The process:**
 
-![Stage 1](https://github.com/software-engineering-project-org/vscode-plugin-automotive-app-deployment/blob/main/resources/stage_1.png)
+![Deployment-Variant 01](https://github.com/software-engineering-project-org/vscode-plugin-automotive-app-deployment/blob/main/resources/deployment-variant_1.png)
 
 
 **Detailed steps the Extension performs for you:**
@@ -60,13 +59,13 @@ Use this STAGE to install Velocitas App images on a target device from a remote
 
   
 
-###  STAGE 2: The Hybrid Build
+###  Deployment-Variant 02: The Hybrid Build
 
   
 
 **Description:**
 
-Use this STAGE to first download the Velocitas App image from the web (or specify a local path to a .tar file) and then transfer it to the target system via a local network. The target system does not require an Internet connection. If a local path is specified, the source device does not require an internet connection as well.
+Use this Deployment-Variant to first download the Velocitas App image from the web (or specify a local path to a .tar file) and then transfer it to the target system via a local network. The target system does not require an Internet connection. If a local path is specified, the source device does not require an internet connection as well.
 
 **Prerequisites:**
 
@@ -76,7 +75,7 @@ Use this STAGE to first download the Velocitas App image from the web (or specif
 
 **The process:**
 
-![Stage 2](https://github.com/software-engineering-project-org/vscode-plugin-automotive-app-deployment/blob/main/resources/stage_2.png)
+![Deployment-Variant 02](https://github.com/software-engineering-project-org/vscode-plugin-automotive-app-deployment/blob/main/resources/deployment-variant_2.png)
 
   
 
@@ -94,13 +93,13 @@ Use this STAGE to first download the Velocitas App image from the web (or specif
 
   
 
-###  STAGE 3: The Local Build
+###  Deployment-Variant 03: The Local Build
 
   
 
 **Description:**
 
-Use this STAGE to build the Velocitas App image locally via Docker build. The deployment is completely done on a local network, so no internet connection is required, neither on the source device nor on the target device.
+Use this Deployment-Variant to build the Velocitas App image locally via Docker build. The deployment is completely done on a local network, so no internet connection is required, neither on the source device nor on the target device.
 
   
 
@@ -114,7 +113,7 @@ Use this STAGE to build the Velocitas App image locally via Docker build. The de
 
 **The process:**
 
-![Stage 3](https://github.com/software-engineering-project-org/vscode-plugin-automotive-app-deployment/blob/main/resources/stage_3.png)
+![Deployment-Variant 03](https://github.com/software-engineering-project-org/vscode-plugin-automotive-app-deployment/blob/main/resources/deployment-variant_3.png)
 
   
 
@@ -154,11 +153,11 @@ Use this STAGE to build the Velocitas App image locally via Docker build. The de
 -  **Deploy apps on devices using LAD:**
 
 	-  To deploy a Velocitas App with LAD, you can choose between the three variants described above:
-	-  The cloud icon without an arrow executes STAGE 1 option 
+	-  The cloud icon without an arrow executes Deployment-Variant 01 option 
 		"Deploy remote built image remote".
-	-  The cloud with the arrow executes STAGE 2 option 
+	-  The cloud with the arrow executes Deployment-Variant 02 option 
 		"Deploy local built image remote".
-	-  The document icon with the arrow executes STAGE 3 option 
+	-  The document icon with the arrow executes Deployment-Variant 03 option 
 		"Deploy local built image local".
 
 ###  Add the local registry on the target device

package-lock.json

@@ -71,17 +71,17 @@
           "group": "inline"
         },
         {
-          "command": "automotive-app-deployment.deployStageOne",
+          "command": "automotive-app-deployment.deployVariant01",
           "when": "view == devices",
           "group": "inline"
         },
         {
-          "command": "automotive-app-deployment.deployStageTwo",
+          "command": "automotive-app-deployment.deployVariant02",
           "when": "view == devices",
           "group": "inline"
         },
         {
-          "command": "automotive-app-deployment.deployStageThree",
+          "command": "automotive-app-deployment.deployVariant03",
           "when": "view == devices",
           "group": "inline"
         }
@@ -165,18 +165,18 @@
         "icon": "$(info)"
       },
       {
-        "command": "automotive-app-deployment.deployStageOne",
-        "title": "LAD: Deploy Stage 01",
+        "command": "automotive-app-deployment.deployVariant01",
+        "title": "LAD: Deploy Variant 01",
         "icon": "$(cloud)"
       },
       {
-        "command": "automotive-app-deployment.deployStageTwo",
-        "title": "LAD: Deploy Stage 02",
+        "command": "automotive-app-deployment.deployVariant02",
+        "title": "LAD: Deploy Variant 02",
         "icon": "$(cloud-download)"
       },
       {
-        "command": "automotive-app-deployment.deployStageThree",
-        "title": "LAD: Deploy Stage 03",
+        "command": "automotive-app-deployment.deployVariant03",
+        "title": "LAD: Deploy Variant 03",
         "icon": "$(file-symlink-file)"
       },
       {

package.json

@@ -9,21 +9,21 @@
 <h1>Welcome to the User Manual for LAD: Leda App Deployer</h1>
     <p>
         LAD facilitates the installation of an Eclipse Velocitas App on a target device running Eclipse Leda (with Kanto).
-        With LAD, three different deployment options called "STAGES" are selectable.
+        With LAD, three different deployment options called "Deployment-Variants" are selectable.
 
         <p><strong>NOTE:</strong> The base requirement is to have one (or many) target device(s) which can be accessed from this source device via SSH. 
-            <br>Each STAGE requires configurations on the source and/or the target system, which is described in the prerequisites of each STAGE.</p>
+            <br>Each Deployment-Variant requires configurations on the source and/or the target system, which is described in the prerequisites of each Deployment-Variant.</p>
     </p>
     <br>
 
-<h2>Three different Ways (called "STAGES") to deploy your Application </h2>
+<h2>Three different Ways (called "Deployment-Variants") to deploy your Application </h2>
 
-<h3>STAGE 1: The Remote Build</h3>
+<h3>Deployment-Variant 01: The Remote Build</h3>
     <div style="margin-left: 40px">
 
         <p><strong>Description:</strong></p>
         <p> 
-            Use this STAGE to install Velocitas App images on target device from a remote source. Images refer to the available images in the GitHub repositories' registry (ghcr) your application is pulled from.
+            Use this Deployment-Variant to install Velocitas App images on target device from a remote source. Images refer to the available images in the GitHub repositories' registry (ghcr) your application is pulled from.
             <br>The target system automatically downloads the specified image from the remote GitHub Repository with the help of LAD. You can choose between the different image releases which are available for your Repository via dropdown. 
         </p>
 
@@ -34,7 +34,7 @@ <h3>STAGE 1: The Remote Build</h3>
             </ul>
 
         <p><strong>The process:</strong></p>
-            <img src="${stage_1}" width="500" />
+            <img src="${deployment-variant_1}" width="500" />
 
         <p><strong>Detailed steps the extension performs for you: </strong></p>
             <ol>
@@ -48,12 +48,12 @@ <h3>STAGE 1: The Remote Build</h3>
         </br>
     </div>
 
-<h3>STAGE 2: The Hybrid Build</h3>
+<h3>Deployment-Variant 02: The Hybrid Build</h3>
     <div style="margin-left: 40px">
 
         <p><strong>Description:</strong></p>
             <p>
-                Use this STAGE to first download the Velocitas App image from the web (or specify a local path to .tar file) and then transfers it to the target system via local network.
+                Use this Deployment-Variant to first download the Velocitas App image from the web (or specify a local path to .tar file) and then transfers it to the target system via local network.
                 <br>The target system does not require an Internet connection. If a local path is specified, source device does not require an internet connection as well.
             </p>
         <p><strong>Prerequisites:</strong></p>
@@ -62,7 +62,7 @@ <h3>STAGE 2: The Hybrid Build</h3>
             </ul>
 
         <p><strong>The process:</strong> </p>
-            <img src="${stage_2}" width="500" />
+            <img src="${deployment-variant_2}" width="500" />
 
         <p><strong>Detailed steps the extension performs for you: </strong></p>
             <ol>
@@ -77,12 +77,12 @@ <h3>STAGE 2: The Hybrid Build</h3>
         </br>
     </div>
 
-<h3>STAGE 3: The local build</h3>
+<h3>Deployment-Variant 03: The local build</h3>
     <div style="margin-left: 40px">
 
         <p><strong>Description:</strong></p> 
             <p>
-                Use this STAGE to build the Velocitas App image locally via Docker build. 
+                Use this Deployment-Variant to build the Velocitas App image locally via Docker build. 
                 <br>The deployment is completely done in local network, so no internet connection is required, neither on the source device, nor on the target device.
             </p>
 
@@ -93,7 +93,7 @@ <h3>STAGE 3: The local build</h3>
                 <li>Local registry on target device: Allow the use beforehand by referring to section "Add the local registry on the target device".</li>
             </ul>
         <p><strong>The process:</strong> </p>
-            <img src="${stage_3}" width="500" />
+            <img src="${deployment-variant_3}" width="500" />
         <p><strong>Detailed steps the extension performs for you: </strong></p>
             <ol>
                 <li>Builds Docker Image (checks included)</li>
@@ -133,9 +133,9 @@ <h3>Add, remove & edit target devices; run apps on device</h3>
                 <br> To deploy a Velocitas App with LAD, you can choose between the three variants described above:
                 <br>
                     <ul>
-                        <li>The cloud icon without arrow executes STAGE 1 option - "Deploy remote built image remote". </li>
-                        <li>The cloud with the arrow executes STAGE 2 option - "Deploy local built image remote". </li>
-                        <li>The document icon with the arrow executes STAGE 3 option "Deploy local built image local"</li>
+                        <li>The cloud icon without arrow executes Deployment-Variant 01 option - "Deploy remote built image remote". </li>
+                        <li>The cloud with the arrow executes Deployment-Variant 02 option - "Deploy local built image remote". </li>
+                        <li>The document icon with the arrow executes Deployment-Variant 03 option "Deploy local built image local"</li>
                     </ul>
             </p>    
         </br>

resources/stage_1.png renamed to resources/deployment-variant_1.png

@@ -17,9 +17,9 @@
 import * as vscode from 'vscode';
 import { LedaDeviceTreeItem, DeviceDataProvider } from './provider/DeviceDataProvider';
 import { addDevice, deleteDevice } from './cmd/DeviceCommands';
-import { StageOne } from './cmd/StageOne';
-import { StageTwo } from './cmd/StageTwo';
-import { StageThree } from './cmd/StageThree';
+import { DeploymentVariant01 } from './cmd/DeploymentVariant01';
+import { DeploymentVariant02 } from './cmd/DeploymentVariant02';
+import { DeploymentVariant03 } from './cmd/DeploymentVariant03';
 import { Credentials } from './svc/Credentials';
 import { openUserManual } from './utils/openUserManual';
 
@@ -99,25 +99,25 @@ export default class LedaAppDeployer {
       }),
     );
 
-    // Register the 'deployStageOne' command and associate it with the 'StageOne.deploy' function
+    // Register the 'deployWithDeploymentVariant01' command and associate it with the 'DeploymentVariant01.deployWith' function
     this.context.subscriptions.push(
-      vscode.commands.registerCommand('automotive-app-deployment.deployStageOne', async (item: LedaDeviceTreeItem) => {
+      vscode.commands.registerCommand('automotive-app-deployment.deployVariant01', async (item: LedaDeviceTreeItem) => {
         const octokit = await this.credentials.getOctokit();
-        await StageOne.deploy(item, octokit);
+        await DeploymentVariant01.deployWith(item, octokit);
       }),
     );
 
-    // Register the 'deployStageTwo' command and associate it with the 'StageTwo.deploy' function
+    // Register the 'deployWithDeploymentVariant02' command and associate it with the 'DeploymentVariant02.deployWith' function
     this.context.subscriptions.push(
-      vscode.commands.registerCommand('automotive-app-deployment.deployStageTwo', async (item: LedaDeviceTreeItem) => {
-        await StageTwo.deploy(item);
+      vscode.commands.registerCommand('automotive-app-deployment.deployVariant02', async (item: LedaDeviceTreeItem) => {
+        await DeploymentVariant02.deployWith(item);
       }),
     );
 
-    // Register the 'deployStageThree' command and associate it with the 'StageThree.deploy' function
+    // Register the 'deployWithDeploymentVariant03' command and associate it with the 'DeploymentVariant03.deployWith' function
     this.context.subscriptions.push(
-      vscode.commands.registerCommand('automotive-app-deployment.deployStageThree', async (item: LedaDeviceTreeItem) => {
-        await StageThree.deploy(item);
+      vscode.commands.registerCommand('automotive-app-deployment.deployVariant03', async (item: LedaDeviceTreeItem) => {
+        await DeploymentVariant03.deployWith(item);
       }),
     );
   }