Instructions on how to fork and update usecases

Strmiska · Jan 25, 2022 · 9c5b73b · 9c5b73b
1 parent 08765df
commit 9c5b73b
Show file tree

Hide file tree

Showing 25 changed files with 86 additions and 12 deletions.
diff --git a/README.md b/README.md
@@ -1 +1,75 @@
-# DesignSafe Use Case Template
+# DesignSafe Use Case Template
+
+## A guide to adding your use case project
+
+1. Fork the DS Use Case template from the GitHub [repo](https://github.com/erathje71/DS_Use_Case_template/). If prompted, select an organziation to create the fork.
+
+    ![fork](images/00-fork.png)
+
+    ![forking](images/01-forking.png)
+
+1. GitHub will create a forked repo in your user account. Note, the new repo will say it was forked from the original [https://github.com/erathje71/DS_Use_Case_template/](https://github.com/erathje71/DS_Use_Case_template/).
+    ![forked-repo](images/02-forked-repo.png)
+
+1. Navigate to your use case folder, which is located in the `docs` folder. The folders are named after the PI, so find the folder with your name to edit your template. **Always check you are only editing your use case folder**.
+    ![PI use case folder](images/03-pi-usecase-folder.png)
+
+1. Click on the `usecase.md` file in your usecase folder to edit your usecase. 
+    ![Edit usecase md](images/04-edit-usecasemd.png)
+
+    ![Edited usecase](images/05-edit-usecase.png)
+
+1. Once you have completed editing your use case, you save your changes by commiting. Scroll down to the bottom of the page and type a descriptive phrase explaining the changes you have made and click "Commit changes". These changes will be saved only on your repo and will not be reflected in the original DS Use Case repository until you create a pull request.
+
+    ![commit edits](images/06-commit-usecase-edits.png)
+
+1. To add images to your use case, navigate to your use case folder and select `img` folder. **Ensure that you are in your usecase `img` folder** before adding images.
+
+    ![img folder](images/07-img-folder.png)
+    ![add image](images/08-add-img.png)
+
+1. Select image files (you can select multiple files) and click add. Once the images are added as shown below, type a descriptive commit message and click `Commit Changes` to add relevant images to your folder. 
+
+    ![upload image](images/09-upload-image.png)
+
+1. To insert the image in your `usecase.md` file, use the following command:
+    ```
+    ![alternate text](image-location.png)
+    ```
+   In this case, we added an image called `mpm-algorithm.png`, which is located in the use case folder `img`. We can reference it in the text using:
+    ```
+    ![mpm algorithm](img/mpm-algorithm.png)
+    ```
+   > Note: Use relative path `img/mpm-algorithm.png`, **do not use full paths** (e.g., "https://github.com/kks32/DS_Use_Case_Template/docs/kumar/img/mpm-algorithm.png").
+
+   You can use the preview tab to check images and text formatting before commiting your changes. 
+
+   ![preview image](images/11-preview-img.png)
+
+   Commit your changes to GitHub with a meaningful message.
+
+   ![image commit](images/12-image-commit.png)
+
+1. Before you are ready to make changes to the original DS Use Case repo. Make sure your repository on GitHub is up to date with all the changes from the original repo. You can do this by navigating your repo and click on `Fetch upstream`. It should say nothing new to fetch. 
+    ![fetch upstream](images/16-fetch-upstream.png)
+
+    If there are any new changes you can fetch and merge.
+    ![fetch merge](images/17-fetch-merge.png)
+
+1. Once you have completed making changes, you'll now create a Pull Request (PR) to request that your changes be merged to the main DesignSafe Use Case repo. Go to your repo on GitHub (in my case it is [https://github.com/kks32/DS_Use_Case_Template](https://github.com/kks32/DS_Use_Case_Template)). And select `Contribute`, check if it says `This branch is XX comits **ahead** of erathje71 master`, before opening a pull request:
+
+    ![Open PR](images/18-open-pr.png)
+
+    Complete the title and description of your PR and select `Create Pull Request`:
+
+    ![Create PR](images/19-create-pr.png)
+
+    The PR will show all the changes you have made in the `Files Changed` tab:
+
+    ![PR changes](images/20-pr-file-changes.png)
+
+1. After a minute or so a preview deployment of your use case will be available on the pull request page. Select the preview link generated by Netlify to view your changes similar to how it would be rendered in the final version. If you want to make some tweaks. Visit *your* GitHub repo of the DS Use Case and make changes. As long as the current PR remains open GitHub will automatically pull your changes. 
+
+    ![PR](images/21-pr.png)
+
+    ![preview Web](images/22-preview.png)
diff --git a/images/00-fork.png b/images/00-fork.png
diff --git a/images/01-forking.png b/images/01-forking.png
diff --git a/images/02-forked-repo.png b/images/02-forked-repo.png
diff --git a/images/03-pi-usecase-folder.png b/images/03-pi-usecase-folder.png
diff --git a/images/04-edit-usecasemd.png b/images/04-edit-usecasemd.png
diff --git a/images/05-edit-usecase.png b/images/05-edit-usecase.png
diff --git a/images/06-commit-usecase-edits.png b/images/06-commit-usecase-edits.png
diff --git a/images/07-img-folder.png b/images/07-img-folder.png
diff --git a/images/08-add-img.png b/images/08-add-img.png
diff --git a/images/09-upload-image.png b/images/09-upload-image.png
diff --git a/images/10-add-img-md.png b/images/10-add-img-md.png
diff --git a/images/11-preview-img.png b/images/11-preview-img.png
diff --git a/images/12-image-commit.png b/images/12-image-commit.png
diff --git a/images/13-open-pr.png b/images/13-open-pr.png
diff --git a/images/14-pr-changes.png b/images/14-pr-changes.png
diff --git a/images/15-create-pr.png b/images/15-create-pr.png
diff --git a/images/16-fetch-upstream.png b/images/16-fetch-upstream.png
diff --git a/images/17-fetch-merge.png b/images/17-fetch-merge.png
diff --git a/images/18-open-pr.png b/images/18-open-pr.png
diff --git a/images/19-create-pr.png b/images/19-create-pr.png
diff --git a/images/20-pr-file-changes.png b/images/20-pr-file-changes.png
diff --git a/images/21-pr.png b/images/21-pr.png
diff --git a/images/22-preview.png b/images/22-preview.png
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -25,17 +25,17 @@ markdown_extensions:
 nav:
   - Use Cases : index.md
   - Example : example/usecase.md
-  - Use Case 1: arduino/usecase.md
-  - Use Case 2: brandenberg/usecase.md
-  - Use Case 3: dawson/usecase.md
-  - Use Case 4: haan/usecase.md
-  - Use Case 5: kareen/usecase.md
-  - Use Case 6: kumar/usecase.md
-  - Use Case 7: lowes/usecase.md
-  - Use Case 8: mosqueda/usecase.md
-  - Use Case 9: padgett/usecase.md
-  - Use Case 10: pinelli/usecase.md
-  - Use Case 11: rathje/usecase.md
+  - Use Case 1 - Arduino: arduino/usecase.md
+  - Use Case 2 - Brandenberg: brandenberg/usecase.md
+  - Use Case 3 - Dawson: dawson/usecase.md
+  - Use Case 4 - Haan: haan/usecase.md
+  - Use Case 5 - Kareen: kareen/usecase.md
+  - Use Case 6 - Kumar: kumar/usecase.md
+  - Use Case 7 - Lowes: lowes/usecase.md
+  - Use Case 8 - Mosqueda: mosqueda/usecase.md
+  - Use Case 9 - Padgett: padgett/usecase.md
+  - Use Case 10 - Pinelli: pinelli/usecase.md
+  - Use Case 11 - Rathje: rathje/usecase.md
 
 
 #### DO NOT MAKE ANY CHANGES TO THE EXAMPLE FOLDER