Skip to content

Commit 88e4711

Browse files
committed
Update documentation for extensions development.
1 parent 424afe8 commit 88e4711

File tree

2 files changed

+206
-78
lines changed

2 files changed

+206
-78
lines changed

website/docs/developing/0010-develop-guide.md

Lines changed: 39 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -911,23 +911,25 @@ examples illustrate how to do this.
911911

912912

913913
Once the profile is created, setup Visual Studio for debugging
914-
1. Set the solution configuration to **Debug** at the top of the Visual Studio IDE window.
915-
2. Set the **VirtualClient.Main** project as the startup project. To do so, right-click on the project in the Solution Explorer and select
914+
* Set the solution configuration to **Debug** at the top of the Visual Studio IDE window.
915+
916+
* Set the **VirtualClient.Main** project as the startup project. To do so, right-click on the project in the Solution Explorer and select
916917
**Set as Startup Project** from the context menu.
917-
3. Right-click on the VirtualClient.Main project and open the **Debug** options. Set the following information.
918-
* Application arguments =```--profile={PathToCustomProfile} --profile=MONITORS-NONE.json --packages="{PackageStoreConnectionString|SASUri}"```.
919-
(e.g. ```--profile=S:\one\debugging\DEBUG-EXAMPLE-WORKLOAD.json --profile=MONITORS-NONE.json --packages="https://virtualclient..."```)
920-
4. Place a breakpoint in the code where you like (e.g. in the InitializeAsync or ExecuteAsync methods of your component).
921-
5. Click the play/continue button at the top-center of the Visual Studio IDE window (or press the F5 key).
918+
919+
* Right-click on the VirtualClient.Main project and open the **Debug** options. Set the following information.
920+
* Application arguments = \{VirtualClientCommandLine\}
921+
(e.g. `--profile=S:\one\debugging\DEBUG-EXAMPLE-WORKLOAD.json --profile=MONITORS-NONE.json --packages="https://virtualclient..."`)
922+
923+
* Place a breakpoint in the code where you like (e.g. in the InitializeAsync or ExecuteAsync methods of your component).
924+
925+
* Click the play/continue button at the top-center of the Visual Studio IDE window (or press the F5 key).
922926

923927

924928
* **Custom Profile Option #2**
925929
This option is the same as option #1 above except that the developer will copy the workload dependency package to the appropriate directory in the
926930
Virtual Client build output directory ahead of time. Once the package is in this directory, the Virtual Client does not need to download it and thus
927931
the custom profile can be simplified by removing the "Dependencies" section as illustrated below.
928932

929-
930-
931933
``` json
932934
# A custom profile is created and placed on the file system somewhere (typically somewhere outside of the source directory). In this profile, the
933935
# custom action/executor component is added to the actions.
@@ -958,14 +960,18 @@ examples illustrate how to do this.
958960
```
959961

960962
Once the profile is created, setup Visual Studio for debugging
961-
1. Set the solution configuration to **Debug** at the top of the Visual Studio IDE window.
962-
2. Set the **VirtualClient.Main** project as the startup project. To do so, right-click on the project in the Solution Explorer and select
963+
* Set the solution configuration to **Debug** at the top of the Visual Studio IDE window.
964+
965+
* Set the **VirtualClient.Main** project as the startup project. To do so, right-click on the project in the Solution Explorer and select
963966
**Set as Startup Project** from the context menu.
964-
3. Right-click on the VirtualClient.Main project and open the **Debug** options. Set the following information.
965-
* Application arguments = ```--profile={PathToCustomProfile} --profile=MONITORS-NONE.json```.
966-
(e.g. ```--profile=S:\one\debugging\DEBUG-EXAMPLE-WORKLOAD.json --profile=MONITORS-NONE.json```)
967-
4. Place a breakpoint in the code where you like (e.g. in the InitializeAsync or ExecuteAsync methods of your component).
968-
5. Click the play/continue button at the top-center of the Visual Studio IDE window (or press the F5 key).
967+
968+
* Right-click on the VirtualClient.Main project and open the **Debug** options. Set the following information.
969+
* Application arguments = \{VirtualClientCommandLine\}
970+
(e.g. `--profile=S:\one\debugging\DEBUG-EXAMPLE-WORKLOAD.json --profile=MONITORS-NONE.json`)
971+
972+
* Place a breakpoint in the code where you like (e.g. in the InitializeAsync or ExecuteAsync methods of your component).
973+
974+
* Click the play/continue button at the top-center of the Visual Studio IDE window (or press the F5 key).
969975

970976
* **Custom Profile Option #3**
971977
This option is the same as option #2 above except that we will set an environment variable to the path/directory location of the workload dependency
@@ -992,25 +998,30 @@ examples illustrate how to do this.
992998
}
993999
```
9941000

995-
The workload dependencies package exists in a directory on the system already. We set an environment variable **VCDependenciesPath** to this path/directory location
1001+
The workload dependencies package exists in a directory on the system already. We set an environment variable **VC_PACKAGES_PATH** to this path/directory location
9961002
before beginning to debug.
9971003

9981004
```
9991005
e.g.
10001006
1001-
# Workload dependency package exists in a folder on the file system. We will set the 'VCDependenciesPath' environment variable to this
1002-
# location.
1007+
# Workload dependency package exists in a folder on the file system. We will set the 'VC_PACKAGES_PATH' environment
1008+
# variable to this location.
10031009
S:\one\debugging\packages\exampleworkload.1.0.0.zip
10041010
```
10051011

10061012
Once the profile is created, setup Visual Studio for debugging
1007-
1. Set the solution configuration to **Debug** at the top of the Visual Studio IDE window.
1008-
2. Set the **VirtualClient.Main** project as the startup project. To do so, right-click on the project in the Solution Explorer and select
1013+
* Set the solution configuration to **Debug** at the top of the Visual Studio IDE window.
1014+
1015+
* Set the **VirtualClient.Main** project as the startup project. To do so, right-click on the project in the Solution Explorer and select
10091016
**Set as Startup Project** from the context menu.
1010-
3. Right-click on the VirtualClient.Main project and open the **Debug** options. Set the following information.
1011-
* Application arguments = ```--profile={PathToCustomProfile}```.
1012-
(e.g. ```--profile=S:\one\debugging\DEBUG-EXAMPLE-WORKLOAD.json --profile=MONITORS-NONE.json```)
1013-
* Environment variables = Add the ```VCDependenciesPath``` variable and the path to your package directory.
1014-
(e.g. ```VCDependenciesPath = S:\one\debugging\packages```)
1015-
4. Place a breakpoint in the code where you like (e.g. in the InitializeAsync or ExecuteAsync methods of your component).
1016-
5. Click the play/continue button at the top-center of the Visual Studio IDE window (or press the F5 key).
1017+
1018+
* Right-click on the VirtualClient.Main project and open the **Debug** options. Set the following information.
1019+
* Application arguments = \{VirtualClientCommandLine\}
1020+
(e.g. `--profile=S:\one\debugging\DEBUG-EXAMPLE-WORKLOAD.json --profile=MONITORS-NONE.json`)
1021+
1022+
* Environment variables = Add the `VC_PACKAGES_PATH` variable and the path to your package directory.
1023+
(e.g. `VC_PACKAGES_PATH = S:\one\debugging\packages`)
1024+
1025+
* Place a breakpoint in the code where you like (e.g. in the InitializeAsync or ExecuteAsync methods of your component).
1026+
1027+
* Click the play/continue button at the top-center of the Visual Studio IDE window (or press the F5 key).

0 commit comments

Comments
 (0)