Conversation
temporary directory
remote_function/README.md
Outdated
| 1. Copy the `remote_function` directory on the machine you want to run the remote server. Can be run on any location, independent of where VDMS is running. However, the location should be reachable from the machine that is running VDMS. You can also use `sparse-checkout` to only retrieve the `remote_function` directory from the VDMS repo. | ||
| 2. Create the operation scripts as python scripts and place them in the `remote_function/functions` directory. | ||
| 4. Follow the following steps to run the remote on port <port_number>. | ||
| 2. Copy `resources` directory (located at the root of the repository) next to the `remote_function` directory. |
There was a problem hiding this comment.
For clarification, when you say next to should the resources directory be copied into the remote_function directory? So resulting directory would be remote_function/resources? If this is correct, I suggest changing it to:
| 2. Copy `resources` directory (located at the root of the repository) next to the `remote_function` directory. | |
| 2. Copy `resources` directory (located at the root of the repository) into the `remote_function` directory. |
There was a problem hiding this comment.
Hi Chaunté, the "resources" and "remote_function" directories should be siblings.
As they are siblings directories, could you please tell me if I should clarify that or if the use of "next" could confuse to the reader?
Thank you.
There was a problem hiding this comment.
@rolandoquesada, I'm was a little confused with the next to term. When you say sibling directories, they should be in same parent directory? So say we have parent/remote_function, then the resources path should be parent/resources? If so, I suggest:
| 2. Copy `resources` directory (located at the root of the repository) next to the `remote_function` directory. | |
| 2. Copy `resources` directory (located at the root of the repository) into the same directory as the `remote_function` directory. |
What do you think?
There was a problem hiding this comment.
The suggestion by @cwlacewe sounds good.
Otherwise, you can include the resources directory copy instruction in Step 1 if it still sounds confusing. So you say, "Copy the remote_function and resources directories on the machine you want to run the remote server. Both should be in the same parent directory. It can be on any server, independent of where VDMS is running. However, the server should be reachable from the machine that is running VDMS."
remote_function/README.md
Outdated
|
|
||
| 1. Copy `remote_function` directory to your remote server machine. Say the address is `my.remote.server` and you copy the folder in the `home` directory. The folder structure you have now will look something like this; | ||
| 1. Copy `remote_function` directory to your remote server machine. Say the address is `my.remote.server` and you copy the folder in the `home` directory. | ||
| 2. Copy `resources` directory (located at the root of the repository) next to the `remote_function` directory. The folder structure you have now will look something like this; |
There was a problem hiding this comment.
Same comment as Setup section
user_defined_operations/README.md
Outdated
|
|
||
| 1. Copy `user_defined_operations` directory to anywhere you want but on the same server that is running VDMS. Say you copy the folder in the `home` directory. The folder structure you have now will look something like this; | ||
| 1. Copy `user_defined_operations` directory to anywhere you want but on the same server that is running VDMS. Say you copy the folder in the `home` directory. | ||
| 2. Copy `resources` directory (located at the root of the repository) next to the `user_defined_operations` directory. The folder structure you have now will look something like this; |
There was a problem hiding this comment.
| 2. Copy `resources` directory (located at the root of the repository) next to the `user_defined_operations` directory. The folder structure you have now will look something like this; | |
| 2. Copy `resources` directory (located at the root of the repository) into the `user_defined_operations` directory. The folder structure you have now will look something like this; |
There was a problem hiding this comment.
Hi Chaunté, the "resources" and "user_defined_operations" directories should be siblings.
As they are siblings directories, could you please tell me if I should clarify that or if the use of "next" could confuse to the reader?
Thank you.
There was a problem hiding this comment.
Hi @cwlacewe and @rv355, as Rohit and I discussed by chat, I modified the README files to explain that the resources directory should be copied into the corresponding remote_function or user_defined_operations directory. Also, I modified the steps so the user can follow that approach.
Please let me know if you see any issues or if you have any suggestions.
Thank you
remote_function/README.md
Outdated
| 1. Copy the `remote_function` directory on the machine you want to run the remote server. Can be run on any location, independent of where VDMS is running. However, the location should be reachable from the machine that is running VDMS. You can also use `sparse-checkout` to only retrieve the `remote_function` directory from the VDMS repo. | ||
| 2. Create the operation scripts as python scripts and place them in the `remote_function/functions` directory. | ||
| 4. Follow the following steps to run the remote on port <port_number>. | ||
| 2. Copy `resources` directory (located at the root of the repository) next to the `remote_function` directory. |
There was a problem hiding this comment.
The suggestion by @cwlacewe sounds good.
Otherwise, you can include the resources directory copy instruction in Step 1 if it still sounds confusing. So you say, "Copy the remote_function and resources directories on the machine you want to run the remote server. Both should be in the same parent directory. It can be on any server, independent of where VDMS is running. However, the server should be reachable from the machine that is running VDMS."
|
Target CPP Coverage: 64.2075% Target Python Coverage: 97.94% |
|
@rolandoquesada I like @rv355's suggestion better |
|
Target CPP Coverage: 64.2075% Target Python Coverage: 97.94% |
|
Target CPP Coverage: 64.2075% Target Python Coverage: 97.94% |
The changes done to the code apply for the issue: #277