[Usecase] VIDEO demo for Github repo for Use Case Documentation

[Rathje, Ellen M]

Hi all:

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.  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).



https://utexas.box.com/s/0rzlsejtyfpbodvyrf9tqxc3uha0nrbm


Please feel free to send me any questions.


Ellen

________________________________
From: Rathje, Ellen M
Sent: Thursday, January 27, 2022 11:13 AM
To: usecase at designsafe-ci.org <usecase at designsafe-ci.org>
Cc: Salvador Tijerina <stijerina at tacc.utexas.edu>
Subject: Github repo for Use Case Documentation--DETAILS!


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.  Here are some specifics:

  *   The repo has been moved to the DesignSafe organization.  It can be accessed at https://github.com/DesignSafe-CI/DS_Use_Case_template
     *   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.  Detailed instructions on forking can be found in the readme section of the repo.
     *   If you had previously forked the repo, you can still utilize the repo you forked.  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).
  *   Each use case PI has a folder with their name on it.  You should only edit the files within your named folder.
  *   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.   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.
  *   An example of a fully documented use case product can be found in the folder 'rathje'.


Please develop a first draft of your documentation and submit a pull request by March 15.

Questions can be directed to me, Sal, or Krishna.

Thanks,

Ellen



_________________________________________

Ellen M. Rathje, Ph.D., P.E., F. ASCE

Professor

Janet S. Cockrell Centennial Chair in Engineering

Director, DesignSafe<https://www.designsafe-ci.org/> Cyberinfrastructure for Natural Hazards Research

Department of Civil, Architectural, and Environmental Engineering

University of Texas at Austin

Phone: 512-232-3683

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.designsafe-ci.org/pipermail/usecase/attachments/20220131/f4f437fd/attachment.html>