diff --git a/README.md b/README.md index 02aa079..8adff95 100644 --- a/README.md +++ b/README.md @@ -4,8 +4,9 @@ DesignSafe [MkDocs](https://mkdocs.readthedocs.io/) documentation with **customi ## Contributing -> [!NOTE] -> For a detailed walkthrough of how to contribute to [Use Cases](https://www.designsafe-ci.org/user-guide/usecases/), see [its README](https://github.com/DesignSafe-CI/DS-User-Guide/blob/main/user-guide/docs/usecases/README.md). +[How to Contirbute to **Use Cases**](https://github.com/DesignSafe-CI/DS-User-Guide/blob/main/user-guide/docs/usecases/README.md) + +How to Contribute **Other Changes**: 1. [Fork](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo) this repository.\ (unless you are a direct collaborator) diff --git a/user-guide/docs/usecases/README.md b/user-guide/docs/usecases/README.md index 265c7a0..cc91435 100644 --- a/user-guide/docs/usecases/README.md +++ b/user-guide/docs/usecases/README.md @@ -1,10 +1,12 @@ -# DesignSafe Use Case Template +# DesignSafe Use Cases + +How to contribute to [DesignSafe Use Cases](https://www.designsafe-ci.org/user-guide/usecases/overview/). ## A Guide to Adding Your Use Case Project ### 1. Fork Repo -The Principal Investigator (PI) should [Fork](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo) the [DS User Guide repo][DS-User-Guide] to their own account. If prompted, select an organziation to create the fork. +The Principal Investigator (PI) should [Fork](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo) this [DS User Guide repo][DS-User-Guide] to their own account. If prompted, select an organziation to create the fork. | fork the repo | | - | diff --git a/user-guide/docs/usecases/rathje/usecase.md b/user-guide/docs/usecases/rathje/usecase.md index 8e88768..540a55b 100644 --- a/user-guide/docs/usecases/rathje/usecase.md +++ b/user-guide/docs/usecases/rathje/usecase.md @@ -22,8 +22,8 @@ The following Jupyter notebooks are available to facilitate the analysis of each | Scope | Jupyter Notebook | Jupyter Lab | | :-------: | :---------: | :---------: | -| Submit job to STKO-compatible OpenSees | SSI_MainDriver.ipynb
[![Open In DesignSafe](https://raw.githubusercontent.com/geoelements/LearnMPM/main/DesignSafe-Badge.svg)](https://jupyter.designsafe-ci.org/hub/user-redirect/lab/tree/CommunityData/Use%20Case%20Products/OpenSees-STKO/SSI_MainDriver.ipynb){:target="_blank"} | SSI_MainDriver.ipynb
[![Open In DesignSafe](https://raw.githubusercontent.com/geoelements/LearnMPM/main/DesignSafe-Badge.svg)](https://jupyter.designsafe-ci.org/hub/user-redirect/notebooks/CommunityData/Use%20Case%20Products/OpenSees-STKO/SSI_MainDriver.ipynb){:target="_blank"} | -| Post-Processing in Jupyter | Example post-processing scripts.ipynb
[![Open In DesignSafe](https://raw.githubusercontent.com/geoelements/LearnMPM/main/DesignSafe-Badge.svg)](https://jupyter.designsafe-ci.org/hub/user-redirect/lab/tree/CommunityData/Use%20Case%20Products/OpenSees-STKO/Example%20post-processing%20scripts.ipynb){:target="_blank"} | Example post-processing scripts.ipynb
[![Open In DesignSafe](https://raw.githubusercontent.com/geoelements/LearnMPM/main/DesignSafe-Badge.svg)](https://jupyter.designsafe-ci.org/hub/user-redirect/notebooks/CommunityData/Use%20Case%20Products/OpenSees-STKO/Example%20post-processing%20scripts.ipynb){:target="_blank"} | +| Submit job to STKO-compatible OpenSees | SSI_MainDriver.ipynb
[![Open In DesignSafe](https://raw.githubusercontent.com/geoelements/LearnMPM/main/DesignSafe-Badge.svg)](https://jupyter.designsafe-ci.org/hub/user-redirect/notebooks/CommunityData/Use%20Case%20Products/OpenSees-STKO/SSI_MainDriver.ipynb){:target="_blank"} | SSI_MainDriver.ipynb
[![Open In DesignSafe](https://raw.githubusercontent.com/geoelements/LearnMPM/main/DesignSafe-Badge.svg)](https://jupyter.designsafe-ci.org/hub/user-redirect/lab/tree/CommunityData/Use%20Case%20Products/OpenSees-STKO/SSI_MainDriver.ipynb){:target="_blank"} | +| Post-Processing in Jupyter | Example post-processing scripts.ipynb
[![Open In DesignSafe](https://raw.githubusercontent.com/geoelements/LearnMPM/main/DesignSafe-Badge.svg)](https://jupyter.designsafe-ci.org/hub/user-redirect/notebooks/CommunityData/Use%20Case%20Products/OpenSees-STKO/Example%20post-processing%20scripts.ipynb){:target="_blank"} | Example post-processing scripts.ipynb
[![Open In DesignSafe](https://raw.githubusercontent.com/geoelements/LearnMPM/main/DesignSafe-Badge.svg)](https://jupyter.designsafe-ci.org/hub/user-redirect/lab/tree/CommunityData/Use%20Case%20Products/OpenSees-STKO/Example%20post-processing%20scripts.ipynb){:target="_blank"} | #### DesignSafe Resources The following DesignSafe resources were used in developing this use case.