https://dev.arvados.org/https://dev.arvados.org/favicon.ico?15576888422020-12-16T17:06:38ZArvadosArvados - Support #17165: Work on user guide & traininghttps://dev.arvados.org/issues/17165?journal_id=894602020-12-16T17:06:38ZPeter Amstutzpeter.amstutz@curii.com
<ul><li><strong>Status</strong> changed from <i>New</i> to <i>In Progress</i></li></ul> Arvados - Support #17165: Work on user guide & traininghttps://dev.arvados.org/issues/17165?journal_id=894812020-12-16T17:27:27ZPeter Amstutzpeter.amstutz@curii.com
<ul><li><strong>Target version</strong> changed from <i>2020-12-16 Sprint</i> to <i>2021-01-06 Sprint</i></li></ul> Arvados - Support #17165: Work on user guide & traininghttps://dev.arvados.org/issues/17165?journal_id=896182021-01-06T17:00:17ZPeter Amstutzpeter.amstutz@curii.com
<ul><li><strong>Target version</strong> changed from <i>2021-01-06 Sprint</i> to <i>2021-01-20 Sprint</i></li></ul> Arvados - Support #17165: Work on user guide & traininghttps://dev.arvados.org/issues/17165?journal_id=900152021-01-20T16:41:59ZPeter Amstutzpeter.amstutz@curii.com
<ul><li><strong>Target version</strong> changed from <i>2021-01-20 Sprint</i> to <i>2021-02-03 Sprint</i></li></ul> Arvados - Support #17165: Work on user guide & traininghttps://dev.arvados.org/issues/17165?journal_id=903132021-02-03T16:47:59ZPeter Amstutzpeter.amstutz@curii.com
<ul><li><strong>Target version</strong> changed from <i>2021-02-03 Sprint</i> to <i>2021-02-17 sprint</i></li></ul> Arvados - Support #17165: Work on user guide & traininghttps://dev.arvados.org/issues/17165?journal_id=903742021-02-04T17:51:15ZNico César
<ul><li><strong>File</strong> <a href="/attachments/2653">2021-02-04_12-48.png</a> <a class="icon-only icon-download" title="Download" href="/attachments/download/2653/2021-02-04_12-48.png">2021-02-04_12-48.png</a> added</li></ul><p>review at <a class="changeset" title="17165: Update training after going back over it step-by-step Arvados-DCO-1.1-Signed-off-by: Pete..." href="https://dev.arvados.org/projects/arvados/repository/arvados/revisions/984703527b7205372d28a9c27e8356986d3ba278">984703527b7205372d28a9c27e8356986d3ba278</a></p>
<p>Is the intention the rake task <code>import_vscode_training</code> from time to time to sync up the content of our repo when <a class="external" href="https://github.com/arvados/arvados-vscode-cwl-training">https://github.com/arvados/arvados-vscode-cwl-training</a> gets updated? if so, that part looks good to me and I think is ready to merge to Arvados Repo.</p>
<p>about the content of the training, this are my open questions:</p>
<p>there are many references to Windows only install (like /c/Users/MyUsername/.ssh/id_rsa.pub), shall we add a Note that this is Windows only or shall we expand to other operating systems?</p>
<p>Step 1.3.iv (see screenshot) could be confusing if no shell nodes are available.</p>
<p>We should add notes/screenshot of what to expect. Since users can be doing a lot of steps but is something looks fishy should be pointed out.</p> Arvados - Support #17165: Work on user guide & traininghttps://dev.arvados.org/issues/17165?journal_id=904762021-02-09T19:27:18ZPeter Amstutzpeter.amstutz@curii.com
<ul></ul><p>Nico César wrote:</p>
<blockquote>
<p>review at <a class="changeset" title="17165: Update training after going back over it step-by-step Arvados-DCO-1.1-Signed-off-by: Pete..." href="https://dev.arvados.org/projects/arvados/repository/arvados/revisions/984703527b7205372d28a9c27e8356986d3ba278">984703527b7205372d28a9c27e8356986d3ba278</a></p>
<p>Is the intention the rake task <code>import_vscode_training</code> from time to time to sync up the content of our repo when <a class="external" href="https://github.com/arvados/arvados-vscode-cwl-training">https://github.com/arvados/arvados-vscode-cwl-training</a> gets updated? if so, that part looks good to me and I think is ready to merge to Arvados Repo.</p>
<p>about the content of the training, this are my open questions:</p>
<p>there are many references to Windows only install (like /c/Users/MyUsername/.ssh/id_rsa.pub), shall we add a Note that this is Windows only or shall we expand to other operating systems?</p>
</blockquote>
<p>I tweaked the text a bit to clarify which instructions are Windows only and which apply to any OS. There's really very little that is Windows specific.</p>
<blockquote>
<p>Step 1.3.iv (see screenshot) could be confusing if no shell nodes are available.</p>
</blockquote>
<p>I'm assuming that users have access to shell nodes, because otherwise none of the rest of the instructions work as written. If you are on Linux and have the Arvados Python SDK installed most of the instructions could still apply, I'm assuming Linux users are more likely to be able to figure that out on their own.</p>
<blockquote>
<p>We should add notes/screenshot of what to expect. Since users can be doing a lot of steps but is something looks fishy should be pointed out.</p>
</blockquote>
<p>I did that with some of the VSCode icons, although not with Workbench 2. Screenshots can go stale very quickly when the thing you are documenting changes a lot. I'm also not sure where people are most likely to get stuck and need extra visual help. I'm open to suggestions but I'd like to get to merging as-is so that I can send Roche a link to the page as displayed on our documentation site instead of it being a separate github repo.</p> Arvados - Support #17165: Work on user guide & traininghttps://dev.arvados.org/issues/17165?journal_id=904922021-02-09T22:30:18ZNico César
<ul><li><strong>File</strong> <a href="/attachments/2656">2021-02-09_17-28.png</a> <a class="icon-only icon-download" title="Download" href="/attachments/download/2656/2021-02-09_17-28.png">2021-02-09_17-28.png</a> added</li><li><strong>File</strong> <a href="/attachments/2655">2021-02-09_17-29.png</a> <a class="icon-only icon-download" title="Download" href="/attachments/download/2655/2021-02-09_17-29.png">2021-02-09_17-29.png</a> added</li><li><strong>File</strong> <a href="/attachments/2657">2021-02-09_17-29_1.png</a> <a class="icon-only icon-download" title="Download" href="/attachments/download/2657/2021-02-09_17-29_1.png">2021-02-09_17-29_1.png</a> added</li></ul><p>Step 2.4 forced me to uninstall and install the extension. See 3 screenshots</p> Arvados - Support #17165: Work on user guide & traininghttps://dev.arvados.org/issues/17165?journal_id=904932021-02-09T22:32:34ZNico César
<ul></ul><p>in 1.3 there could be a bug related to wb2 and admins (or maybe users too...) See Bug <a class="issue tracker-1 status-3 priority-4 priority-default closed" title="Bug: [wb2] ssh keys for admin user list all of them (in the user tab) (Resolved)" href="https://dev.arvados.org/issues/17357">#17357</a></p> Arvados - Support #17165: Work on user guide & traininghttps://dev.arvados.org/issues/17165?journal_id=904942021-02-09T23:48:36ZNico César
<ul></ul><p>section 2.6 shouldn't be labled "Go to Arvados Workbench" since there is a back and forth from wb to vscode</p>
<p>I would add:<br />3.1.iv -> "WORKFLOW_UUID should appear in the directory. You can double check your submission on workbench searching for that UUID"</p> Arvados - Support #17165: Work on user guide & traininghttps://dev.arvados.org/issues/17165?journal_id=905012021-02-10T20:19:54ZPeter Amstutzpeter.amstutz@curii.com
<ul></ul><p>Nico César wrote:</p>
<blockquote>
<p>Step 2.4 forced me to uninstall and install the extension. See 3 screenshots</p>
</blockquote>
<p>Shouldn't be necessary to uninstall. You do need to install it on the remote host, if for some reason you installed it locally, that isn't totally obvious, so I added a note.</p>
<p>Nico César wrote:</p>
<blockquote>
<p>in 1.3 there could be a bug related to wb2 and admins (or maybe users too...) See Bug <a class="issue tracker-1 status-3 priority-4 priority-default closed" title="Bug: [wb2] ssh keys for admin user list all of them (in the user tab) (Resolved)" href="https://dev.arvados.org/issues/17357">#17357</a></p>
</blockquote>
<p>You're right, that's a bug, but that is out of scope for this story, most people doing this won't be admins.</p>
<p>Nico César wrote:</p>
<blockquote>
<p>section 2.6 shouldn't be labled "Go to Arvados Workbench" since there is a back and forth from wb to vscode</p>
</blockquote>
<p>Right, that's a little confusing, I adjusted the text and order a bit.</p>
<blockquote>
<p>I would add:<br />3.1.iv -> "WORKFLOW_UUID should appear in the directory. You can double check your submission on workbench searching for that UUID"</p>
</blockquote>
<p>I added a note about the file showing up. I didn't get into what the contents of the file means, the user doesn't <em>need</em> to know all the details.</p>
<p>17165-vscode-training-doc @ <a class="changeset" title="17165: Sync up again Arvados-DCO-1.1-Signed-off-by: Peter Amstutz <peter.amstutz@curii.com>" href="https://dev.arvados.org/projects/arvados/repository/arvados/revisions/5ccc1a94d1621e319990a4362c131d5ab776c478">5ccc1a94d1621e319990a4362c131d5ab776c478</a></p> Arvados - Support #17165: Work on user guide & traininghttps://dev.arvados.org/issues/17165?journal_id=905022021-02-10T20:22:51ZNico César
<ul></ul><p><a class="changeset" title="17165: Sync up again Arvados-DCO-1.1-Signed-off-by: Peter Amstutz <peter.amstutz@curii.com>" href="https://dev.arvados.org/projects/arvados/repository/arvados/revisions/5ccc1a94d1621e319990a4362c131d5ab776c478">5ccc1a94d1621e319990a4362c131d5ab776c478</a></p>
<p>LGTM, we can always improve later (and re-create a arvados repo merge.)</p> Arvados - Support #17165: Work on user guide & traininghttps://dev.arvados.org/issues/17165?journal_id=906812021-02-18T14:40:55ZPeter Amstutzpeter.amstutz@curii.com
<ul><li><strong>Status</strong> changed from <i>In Progress</i> to <i>Resolved</i></li></ul> Arvados - Support #17165: Work on user guide & traininghttps://dev.arvados.org/issues/17165?journal_id=926362021-05-13T15:08:50ZPeter Amstutzpeter.amstutz@curii.com
<ul><li><strong>Release</strong> set to <i>38</i></li></ul>