<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=Windows-1252">
<style type="text/css" style="display:none;"> P {margin-top:0;margin-bottom:0;} </style>
</head>
<body dir="ltr">
<div style="font-family: Calibri, Arial, Helvetica, sans-serif; font-size: 12pt; color: rgb(0, 0, 0);">
Hi all:</div>
<div style="font-family: Calibri, Arial, Helvetica, sans-serif; font-size: 12pt; color: rgb(0, 0, 0);">
<br>
</div>
<div style="font-family: Calibri, Arial, Helvetica, sans-serif; font-size: 12pt; color: rgb(0, 0, 0);">
During last week's Viz meeting, Krishna did a demo of how to fork, edit, etc. the GitHub Use Case template for your use case. Rather than do this demo at each Use Case meeting, we have a recording of that Zoom meeting that you can use to orient yourself. <span style="color: rgb(32, 31, 30); font-family: Calibri, sans-serif; font-size: 11pt;">Here
is the UT Box link to the recording, and Krishna starts the demo at the 19-minute mark. Pease feel free to share this link with your students who may be doing the actual editing. But remember, we want the faculty member to be the person who forks the github
repo so that you have long term control of your edits (i.e., even after a student graduates).</span></div>
<div style="font-family: Calibri, Arial, Helvetica, sans-serif; font-size: 12pt; color: rgb(0, 0, 0);">
<p class="x_MsoNormal" style="margin:0in 0in 0.0001pt;font-size:11pt;font-family:Calibri, sans-serif;color:rgb(32, 31, 30);background-color:rgb(255, 255, 255)">
</p>
<p class="x_MsoNormal" style="margin:0in 0in 0.0001pt;font-size:11pt;font-family:Calibri, sans-serif;color:rgb(32, 31, 30);background-color:rgb(255, 255, 255)">
<a href="https://utexas.box.com/s/0rzlsejtyfpbodvyrf9tqxc3uha0nrbm" target="_blank" rel="noopener noreferrer" data-auth="NotApplicable" data-linkindex="0" style="margin:0px;color:rgb(5, 99, 193);text-decoration:underline">https://utexas.box.com/s/0rzlsejtyfpbodvyrf9tqxc3uha0nrbm</a></p>
<p class="x_MsoNormal" style="margin:0in 0in 0.0001pt;font-size:11pt;font-family:Calibri, sans-serif;color:rgb(32, 31, 30);background-color:rgb(255, 255, 255)">
<br>
</p>
<p class="x_MsoNormal" style="margin:0in 0in 0.0001pt;font-size:11pt;font-family:Calibri, sans-serif;color:rgb(32, 31, 30);background-color:rgb(255, 255, 255)">
Please feel free to send me any questions.</p>
<p class="x_MsoNormal" style="margin:0in 0in 0.0001pt;font-size:11pt;font-family:Calibri, sans-serif;color:rgb(32, 31, 30);background-color:rgb(255, 255, 255)">
<br>
</p>
<p class="x_MsoNormal" style="margin:0in 0in 0.0001pt;font-size:11pt;font-family:Calibri, sans-serif;color:rgb(32, 31, 30);background-color:rgb(255, 255, 255)">
Ellen</p>
<br>
</div>
<div id="appendonsend"></div>
<hr style="display:inline-block;width:98%" tabindex="-1">
<div id="divRplyFwdMsg" dir="ltr"><font face="Calibri, sans-serif" style="font-size:11pt" color="#000000"><b>From:</b> Rathje, Ellen M<br>
<b>Sent:</b> Thursday, January 27, 2022 11:13 AM<br>
<b>To:</b> usecase@designsafe-ci.org <usecase@designsafe-ci.org><br>
<b>Cc:</b> Salvador Tijerina <stijerina@tacc.utexas.edu><br>
<b>Subject:</b> Github repo for Use Case Documentation--DETAILS!</font>
<div> </div>
</div>
<style type="text/css" style="display:none">
<!--
p
{margin-top:0;
margin-bottom:0}
-->
</style>
<div dir="ltr">
<div style="font-family:Calibri,Arial,Helvetica,sans-serif; font-size:12pt; color:rgb(0,0,0)">
<span style="font-size:12pt; background-color:rgba(0,0,0,0)"></span>
<p class="x_MsoNormal" style="margin:0in 0in 8pt; line-height:107%; font-size:11pt; font-family:Calibri,sans-serif">
<span style="font-family:Calibri,Arial,Helvetica,sans-serif; font-size:12pt; background-color:rgba(0,0,0,0)">With help from Krisha and Sal, we have finally settled on a process for using GitHub and mkdocs to develop an integrated website of documentation for
our Use Case Products.</span><span style="font-family:Calibri,Arial,Helvetica,sans-serif; font-size:12pt; background-color:rgba(0,0,0,0)">
</span><span style="font-family:Calibri,Arial,Helvetica,sans-serif; font-size:12pt; background-color:rgba(0,0,0,0)">Here are some specifics:</span> </p>
<ul style="margin-bottom:0in">
<li><span style="font-size:12pt; background-color:rgba(0,0,0,0)">The repo has been moved to the DesignSafe organization.</span><span style="font-size:12pt; background-color:rgba(0,0,0,0)">
</span><span style="font-size:12pt; background-color:rgba(0,0,0,0)">It can be accessed at
</span><a href="https://github.com/DesignSafe-CI/DS_Use_Case_template"><span style="font-size:12pt; background-color:rgba(0,0,0,0)">https://github.com/DesignSafe-CI/DS_Use_Case_template</span></a> </li><ul style="margin-bottom:0in">
<li><span style="font-size:12pt; background-color:rgba(0,0,0,0)">If you (i.e., PI) have not yet accessed the template repo, please use the link above and fork the repo into your GitHub account.</span><span style="font-size:12pt; background-color:rgba(0,0,0,0)">
</span><span style="font-size:12pt; background-color:rgba(0,0,0,0)">Detailed instructions on forking can be found in the readme section of the repo.</span> </li><li><span style="font-size:12pt; background-color:rgba(0,0,0,0)">If you had previously forked the repo, you can still utilize the repo you forked.</span><span style="font-size:12pt; background-color:rgba(0,0,0,0)">
</span><span style="font-size:12pt; background-color:rgba(0,0,0,0)">However, before continuing to edit your repo, please utilize “Fetch Upstream” to sync your repo with the changes we have made upstream (this is explained in step 9 in the readme section).</span><span style="font-size:12pt; background-color:rgba(0,0,0,0)">
</span> </li></ul>
<li><span style="font-size:12pt; background-color:rgba(0,0,0,0)">Each use case PI has a folder with their name on it.</span><span style="font-size:12pt; background-color:rgba(0,0,0,0)">
</span><span style="font-size:12pt; background-color:rgba(0,0,0,0)">You should only edit the files within your named folder.</span> </li><li><span style="font-size:12pt; background-color:rgba(0,0,0,0)">Detailed, step-by-step instructions (with screen shots) are provided in the readme section of the repo for modifying the usecase.md file within your named folder.</span><span style="font-size:12pt; background-color:rgba(0,0,0,0)">
</span><span style="font-size:12pt; background-color:rgba(0,0,0,0)"> </span><span style="font-size:12pt; background-color:rgba(0,0,0,0)">As a PI you will only need to perform Step 1 of the instructions, which explains how to fork the repo and set up collaborators
(i.e., students/postdocs) who can edit the use case template.</span><span style="font-size:12pt; background-color:rgba(0,0,0,0)">
</span> </li><li>An example of a fully documented use case product can be found in the folder 'rathje'.</li></ul>
<p class="x_MsoNormal" style="margin:0in 0in 8pt; line-height:107%; font-size:11pt; font-family:Calibri,sans-serif">
<b><span style="font-family:Calibri,Arial,Helvetica,sans-serif; font-size:12pt; background-color:rgba(0,0,0,0)"><br>
</span></b></p>
<p class="x_MsoNormal" style="margin:0in 0in 8pt; line-height:107%; font-size:11pt; font-family:Calibri,sans-serif">
<b><span style="font-family:Calibri,Arial,Helvetica,sans-serif; font-size:12pt; background-color:rgba(0,0,0,0)">Please develop a first draft of your documentation and submit a pull request by March 15.</span> </b></p>
<p class="x_MsoNormal" style="margin:0in 0in 8pt; line-height:107%; font-size:11pt; font-family:Calibri,sans-serif">
<span style="font-family:Calibri,Arial,Helvetica,sans-serif; font-size:12pt; background-color:rgba(0,0,0,0)">Questions can be directed to me, Sal, or Krishna.</span><span style="font-family:Calibri,Arial,Helvetica,sans-serif; font-size:12pt; background-color:rgba(0,0,0,0)">
</span> </p>
<p class="x_MsoNormal" style="margin:0in 0in 8pt; line-height:107%; font-size:11pt; font-family:Calibri,sans-serif">
<span style="font-family:Calibri,sans-serif; font-size:11pt; color:rgb(0,0,0)">Thanks,</span><br>
</p>
<p class="x_MsoNormal" style="margin:0in 0in 8pt; line-height:107%; font-size:11pt; font-family:Calibri,sans-serif">
<span style="font-family:Calibri,sans-serif; font-size:11pt; color:rgb(0,0,0)">Ellen</span></p>
<br>
</div>
<div>
<div style="font-family:Calibri,Arial,Helvetica,sans-serif; font-size:12pt; color:rgb(0,0,0)">
<br>
</div>
<div id="x_Signature">
<div>
<div style="font-family:Calibri,Arial,Helvetica,sans-serif; font-size:12pt; color:rgb(0,0,0)">
<p style="text-align:start; background-color:rgb(255,255,255); font-size:11pt; font-family:Calibri,sans-serif; margin:0px">
<a style="margin:0px"><b><span style="margin:0px">_________________________________________ </span></b></a></p>
<p style="text-align:start; background-color:rgb(255,255,255); font-size:11pt; font-family:Calibri,sans-serif; margin:0px">
<span style="margin:0px"><b><span style="margin:0px">Ellen M. Rathje, Ph.D., P.E., F. ASCE </span></b></span></p>
<p style="text-align:start; background-color:rgb(255,255,255); font-size:11pt; font-family:Calibri,sans-serif; margin:0px">
<span style="margin:0px"><span style="margin:0px">Professor </span></span></p>
<p style="text-align:start; background-color:rgb(255,255,255); font-size:11pt; font-family:Calibri,sans-serif; margin:0px">
<span style="margin:0px"><span style="margin:0px">Janet S. Cockrell Centennial Chair in Engineering </span></span></p>
<p style="text-align:start; background-color:rgb(255,255,255); font-size:11pt; font-family:Calibri,sans-serif; margin:0px">
<span style="margin:0px"><span style="margin:0px">Director,<span> </span></span></span><a href="https://www.designsafe-ci.org/" target="_blank" rel="noopener noreferrer" style="margin:0px"><span style="margin:0px"><span style="margin:0px; color:rgb(5,99,193)">DesignSafe</span></span><span style="margin:0px"></span></a><span style="margin:0px"><span style="margin:0px"><span> </span>Cyberinfrastructure
for Natural Hazards Research </span></span></p>
<p style="text-align:start; background-color:rgb(255,255,255); font-size:11pt; font-family:Calibri,sans-serif; margin:0px">
<span style="margin:0px"><span style="margin:0px">Department of Civil, Architectural, and Environmental Engineering </span></span></p>
<p style="text-align:start; background-color:rgb(255,255,255); font-size:11pt; font-family:Calibri,sans-serif; margin:0px">
<span style="margin:0px"><span style="margin:0px">University of Texas at Austin </span></span></p>
<p style="text-align:start; background-color:rgb(255,255,255); font-size:11pt; font-family:Calibri,sans-serif; margin:0px">
<span style="margin:0px"><span style="margin:0px">Phone: 512-232-3683 </span></span></p>
<br>
</div>
</div>
</div>
</div>
</div>
</body>
</html>