Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Modification to link in usecase and nav pane + suggestion to README #43

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 15 additions & 7 deletions README.md
wesleyboar marked this conversation as resolved.
Show resolved Hide resolved
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,11 @@ DesignSafe [MkDocs](https://mkdocs.readthedocs.io/) documentation with **customi
2. [Edit](https://docs.github.com/en/repositories/working-with-files/managing-files/editing-files) relevant files that need update.\
<sup>([upload images](https://docs.github.com/en/repositories/working-with-files/managing-files/adding-a-file-to-a-repository) as necessary)</sup>
4. [Commit](https://docs.github.com/en/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/about-commits) your changes.
5. [Request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request) a review.\
<sup>(a.k.a. create a "Pull Request")</sup>
6. [Test](#testing) your changes.\
5. [Test](#testing) your changes.\
<sup>(if comfortable using a command prompt)</sup>

6. [Request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request) a review.\
<sup>(a.k.a. create a "Pull Request")</sup>

### Resources

* [Markdown syntax (extended)](https://www.markdownguide.org/extended-syntax/) via [MkDocs' Markdown support](https://www.mkdocs.org/user-guide/writing-your-docs/#writing-with-markdown)
Expand Down Expand Up @@ -66,13 +66,21 @@ DesignSafe [MkDocs](https://mkdocs.readthedocs.io/) documentation with **customi
0. Have Docker installed.\
<sup>We recommend doing so via [Docker-Desktop](https://www.docker.com/products/docker-desktop).</sup>
1. Navigate into your clone of this repository.
2. Start the Docker container to serve the docs.
```shell
2. Start the Docker container to serve the docs.

Linux or Mac (macOS) user:
```shell
make build
make start

```
3. Open the website at the URL provided e.g.
Windows user:
```shell
docker-compose -f docker-compose.yml build
docker-compose -f docker-compose.yml up

```
4. Open the website at the URL provided e.g.
[http://0.0.0.1:8000/user-guide/](http://0.0.0.1:8000/user-guide/).


Expand Down
2 changes: 1 addition & 1 deletion user-guide/docs/usecases/padgett/usecase_JN_viz.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ The following Jupyter notebook is the basis for the use case described in this s

| Scope | Notebook |
| :-------: | :---------: |
| visualization of <br> spatially-distributed Data | visualization_risk_resilience.ipynb <br> [![Open In DesignSafe](https://raw.githubusercontent.com/geoelements/LearnMPM/main/DesignSafe-Badge.svg)](https://jupyter.designsafe-ci.org/user/silvia/lab/workspaces/auto-k/tree/NHERI-Published/PRJ-3939v3/visualization_risk_resilience.ipynb)|
| visualization of <br> spatially-distributed Data | visualization_risk_resilience.ipynb <br> [![Open In DesignSafe](https://raw.githubusercontent.com/geoelements/LearnMPM/main/DesignSafe-Badge.svg)](https://jupyter.designsafe-ci.org/hub/user-redirect/lab/tree/NHERI-Published/PRJ-3939v3/visualization_risk_resilience.ipynb)|



Expand Down
1 change: 1 addition & 0 deletions user-guide/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,7 @@ nav:
- ADCIRC: tools/simulation/adcirc/adcirc.md
- ClawPack: tools/simulation/clawpack.md
- Dakota: tools/simulation/dakota.md
- IN-CORE: tools/simulation/in-core.md
- LS-DYNA: tools/simulation/lsdyna.md
- OpenFoam: tools/simulation/openfoam.md
- OpenSees : tools/simulation/opensees/opensees.md
Expand Down