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

fix: remove and do not reference out-of-date pages #108

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open
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
2 changes: 1 addition & 1 deletion user-guide/docs/css/ds-docs.css
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
/* To also support underlining headings in hovered card for `.h1` et cetera */
/* https://github.com/DesignSafe-CI/DS-User-Guide/blob/df64c11/user-guide/docs/usecases/overview.md?plain=1#L34-L37 */
/* https://github.com/TACC/Core-Styles/blob/v2.27.0/src/lib/_imports/components/c-card--docs.css#L23-L29 */
[class*=card--]:hover :is( .h1, .h2, .h3, .h4, .h5, .h6 ) {
a[class*=card--]:hover :is( .h1, .h2, .h3, .h4, .h5, .h6 ) {
Copy link
Collaborator Author

@wesleyboar wesleyboar Dec 18, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I fixed bug that only showed when I changed cards to not be links.

text-decoration-line: underline;
text-decoration-style: solid;
text-decoration-thickness: var(--global-border-width--normal);
Expand Down
77 changes: 43 additions & 34 deletions user-guide/docs/usecases/README.md
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I had to update this because it was all about files I deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -187,49 +187,58 @@ After a minute or so a preview deployment of your use case will be available on

</details>

### <a id="add-to-guide"></a> 12. Add Use Case New to User Guide

If you have added a Use Case, include it into one of the existing use case category documents —

| Category | Document |
| - | - |
| API | [`apiusecases.md`](./apiusecases.md) |
| Data Analytics | [`dataanalyticsusecases.md`](./dataanalyticsusecases.md) |
| Geohazard | [`geohazardusecases.md`](./geohazardusecases.md) |
| Seismic | [`seismicusecases.md`](./seismicusecases.md) |
| Wind and Storm Surge | [`windstormsurgeusecases.md`](./windstormsurgeusecases.md) |
### <a id="add-to-guide"></a> 12. Add New Use Case to User Guide

If you have added a Use Case, add it to the [`nav` in `user-guide/mkdocs.yml`](https://github.com/DesignSafe-CI/DS-User-Guide/blob/v2.2.0/user-guide/mkdocs.yml#L112-L136) —

```yml
- Use Cases:
- Overview: usecases/overview.md
- Data Analytics:
- Multi-Data Set Image Analysis in Taggit: usecases/haan/usecase-3.md
- ...
- GeoHazard:
- NGL Database: usecases/brandenberg-ngl/usecase.md
- ...
- Seismic:
- Seismic Response of Concrete Walls: usecases/lowes/usecase.md
- ...
- Wind and Storm Surge:
- Field Sensing Wind Events: usecases/pinelli/usecase.md
- ...
```

— so that it will show up on this User Guide.

#### Example

To add to [`dataanalyticsusecases.md` (Data Analytics)](./dataanalyticsusecases.md):

1. Find bottommost `{% include-markdown '…' %}` e.g.

```md

---

<!-- ## Visualization of spatially distributed data -->

{% include-markdown 'padgett/usecase_JN_viz.md' %}
To add your use case to "Wind & Storm Surge":

1. Open [`/user-guide/mkdocs.yml`](../../mkdocs.yml).
2. Find the `nav` "Use Cases" hierarchy within "Wind & Storm Surge" category in "Use Cases":
```yaml
nav:
- ...
- Use Cases:
- Overview: ...
- Data Analytics:
- ...
- GeoHazard:
- ...
- Seismic:
- ...
- Wind and Storm Surge:
- ...
```
2. Add an entry for your use case within "Wind & Storm Surge" category in "Use Cases":

<sup>Bottommost include may be different since last update.</sup>

2. Add an include to your document in the same way:

```md

---

<!-- ## Description of yur use case -->

{% include-markdown 'your-usecase/usecase.md' %}
```diff
- Wind and Storm Surge:
- ...
+ - Your Use Case: your-usecase/usecase.md
```

<sup>Edit this include to point to your use case.</sup>
<sup>Edit the new line to reflect your use case.</sup>

[DS-User-Guide]: https://github.com/DesignSafe-CI/DS-User-Guide/
[DS_Use_Case_template]: https://github.com/DesignSafe-CI/DS_Use_Case_template/
8 changes: 4 additions & 4 deletions user-guide/docs/usecases/overview.md
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I just changed <a> to <article> and removing href.

Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ To help users fully embrace DesignSafe functionalities, we have developed a suit
Make sure you are logged into DesignSafe so that you can access the Use-Case products.

/////
///// html | a.card--plain.card--image-top[href="../dataanalyticsusecases/"]
///// html | article.card--plain.card--image-top
markdown: block

////// html | img[alt="a data-driven map in a software interface"][src="./img/data.png"]
Expand All @@ -39,7 +39,7 @@ Data Analytics
Analyze data from multiple datasets, with A.I. and Machine Learning, or via APIs or visualization.

/////
///// html | a.card--plain.card--image-top[href="../geohazardusecases/"]
///// html | article.card--plain.card--image-top
markdown: block

////// html | img[alt="a color-coded landslide"][src="./img/geo.png"]
Expand All @@ -53,7 +53,7 @@ GeoHazard
Geological hazard use cases like liquefaction and landslide modeling.

/////
///// html | a.card--plain.card--image-top[href="../seismicusecases/"]
///// html | article.card--plain.card--image-top
markdown: block

////// html | img[alt="a grid of two kinds of diagonal marks over 4 columns"][src="./img/seismic.jpg"]
Expand All @@ -67,7 +67,7 @@ Seismic
Analyze seismic responses, soil structure interaction, and shake tables. Integrate with OpenSees.

/////
///// html | a.card--plain.card--image-top[href="../windstormsurgeusecases/"]
///// html | article.card--plain.card--image-top
markdown: block

////// html | img[alt="a triangular mesh over shallow water area of a coastal map"][src="./img/wind.png"]
Expand Down
10 changes: 0 additions & 10 deletions user-guide/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -102,20 +102,10 @@ nav:
# - 4. Jupyter & HPC: tools/simulation/opensees/openseesRunJupyterHPC.md
# - 5. TACC: tools/simulation/opensees/openseesRunTACC.md

# - Use Cases Flat:
# - Overview: usecases/overview.md
# - Data Analytics: usecases/dataanalyticsusecases.md
# - GeoHazard: usecases/geohazardusecases.md
# - Seismic: usecases/seismicusecases.md
# - Wind and Storm Surge: usecases/windstormsurgeusecases.md

Comment on lines -105 to -111
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Because I deleted these files, I think I need not archive old links to them.


- Use Cases:
- Overview: usecases/overview.md
- Data Analytics:
# the following have been moved to the user guide. we need to remove these files from the directory in use cases, but doing so would break `{% include-markdown '../usecases/haan/usecase` in `user-guide/docs/tools/visualization.md`
# - Basic Image Browsing and Mapping: usecases/haan/usecase.md
# - Grouping and Tagging Image Files: usecases/haan/usecase-2.md
Comment on lines -116 to -118
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Resolved via #105.

- Multi-Data Set Image Analysis in Taggit: usecases/haan/usecase-3.md
- ML and AI: usecases/vantassel_and_zhang/usecase.md
- Application Programming Interfaces: usecases/brandenberg-api/usecase.md
Expand Down