From c950985dc27ffd34cf658144c1d4e702c0e8d95a Mon Sep 17 00:00:00 2001 From: Selina Ziegler <63650208+zieglerSe@users.noreply.github.com> Date: Fri, 24 Nov 2023 09:03:51 +0100 Subject: [PATCH] Fix doc error Couldn't display SSH Connection article, corrected location --- Slurmi.sln | 2 +- .../docfx_project/articles/sshConnection.md | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) rename sshConnection.md => docs/docfx_project/articles/sshConnection.md (83%) diff --git a/Slurmi.sln b/Slurmi.sln index c858edc..4c85c12 100644 --- a/Slurmi.sln +++ b/Slurmi.sln @@ -31,7 +31,7 @@ EndProject Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "articles", "articles", "{876BAFF8-7221-4E72-A08A-7C242856DAAA}" ProjectSection(SolutionItems) = preProject docs\docfx_project\articles\jobCreation.md = docs\docfx_project\articles\jobCreation.md - sshConnection.md = sshConnection.md + docs\docfx_project\articles\sshConnection.md = docs\docfx_project\articles\sshConnection.md docs\docfx_project\articles\toc.yml = docs\docfx_project\articles\toc.yml docs\docfx_project\articles\workflowCreation.md = docs\docfx_project\articles\workflowCreation.md EndProjectSection diff --git a/sshConnection.md b/docs/docfx_project/articles/sshConnection.md similarity index 83% rename from sshConnection.md rename to docs/docfx_project/articles/sshConnection.md index b558b01..0a9caa6 100644 --- a/sshConnection.md +++ b/docs/docfx_project/articles/sshConnection.md @@ -30,7 +30,7 @@ client.Disconnect() ## Submitting Jobs -To submit a job, you need to create a `Job` object (see [jobCreation](https://csbiology.github.io/Slurmi/articles/jobCreation.html)). +To submit a job, you need to create a [job](../articles/jobCreation.html) object. For a single job, use the function `Runner.sshToTerminal`. This will give you the jobID after submission as an output. @@ -41,7 +41,7 @@ let myJob = let jobID = Runner.sshToTerminal client myJob ``` -When submitting a [workflow](https://csbiology.github.io/Slurmi/articles/workflowCreation.html), use the function `Runner.submitAllSSH`. +When submitting a [workflow](../articles/workflowCreation.html), use the function `Runner.submitAllSSH`. This will resolve the dependencies and submit the jobs in the correct order. ```fsharp