From f7d8544c2833052d6b273885be1461e2e5451b55 Mon Sep 17 00:00:00 2001 From: Wesley B <62723358+wesleyboar@users.noreply.github.com> Date: Tue, 17 Dec 2024 18:25:57 -0600 Subject: [PATCH 1/5] fix: remove links to out-of-date pages --- user-guide/docs/usecases/overview.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/user-guide/docs/usecases/overview.md b/user-guide/docs/usecases/overview.md index aa7451b8..34d4bf24 100644 --- a/user-guide/docs/usecases/overview.md +++ b/user-guide/docs/usecases/overview.md @@ -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"] @@ -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"] @@ -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"] @@ -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"] From 830c9ec0a64d2a1eb85cb40e12ffd7eee0273603 Mon Sep 17 00:00:00 2001 From: Wesley B <62723358+wesleyboar@users.noreply.github.com> Date: Tue, 17 Dec 2024 18:26:47 -0600 Subject: [PATCH 2/5] fix: css assumes a `card` is only ever an `` --- user-guide/docs/css/ds-docs.css | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/user-guide/docs/css/ds-docs.css b/user-guide/docs/css/ds-docs.css index 926deb6f..7b5c9e89 100644 --- a/user-guide/docs/css/ds-docs.css +++ b/user-guide/docs/css/ds-docs.css @@ -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 ) { text-decoration-line: underline; text-decoration-style: solid; text-decoration-thickness: var(--global-border-width--normal); From da84ab82c2de605702ef9e893e2504a6842e8b9c Mon Sep 17 00:00:00 2001 From: Wesley B <62723358+wesleyboar@users.noreply.github.com> Date: Tue, 17 Dec 2024 18:32:10 -0600 Subject: [PATCH 3/5] chore: remove archvied nav of removed docs --- user-guide/mkdocs.yml | 7 ------- 1 file changed, 7 deletions(-) diff --git a/user-guide/mkdocs.yml b/user-guide/mkdocs.yml index 56fe2fea..ae77f107 100644 --- a/user-guide/mkdocs.yml +++ b/user-guide/mkdocs.yml @@ -102,13 +102,6 @@ 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 - - Use Cases: - Overview: usecases/overview.md From 8f371b5e2e3d38c405835dd822a2921f9b1fd223 Mon Sep 17 00:00:00 2001 From: Wesley B <62723358+wesleyboar@users.noreply.github.com> Date: Tue, 17 Dec 2024 18:48:49 -0600 Subject: [PATCH 4/5] chore: remove comment that is resolved by #105 --- user-guide/mkdocs.yml | 3 --- 1 file changed, 3 deletions(-) diff --git a/user-guide/mkdocs.yml b/user-guide/mkdocs.yml index ae77f107..e7487a98 100644 --- a/user-guide/mkdocs.yml +++ b/user-guide/mkdocs.yml @@ -106,9 +106,6 @@ nav: - 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 - 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 From 15a59e9a957d685b4f3f10a2be96e70844873d32 Mon Sep 17 00:00:00 2001 From: Wesley B <62723358+wesleyboar@users.noreply.github.com> Date: Tue, 17 Dec 2024 19:08:21 -0600 Subject: [PATCH 5/5] docs(usecases): update steps to add use case --- user-guide/docs/usecases/README.md | 77 +++++++++++++++++------------- 1 file changed, 43 insertions(+), 34 deletions(-) diff --git a/user-guide/docs/usecases/README.md b/user-guide/docs/usecases/README.md index cc91435e..2469d2db 100644 --- a/user-guide/docs/usecases/README.md +++ b/user-guide/docs/usecases/README.md @@ -187,49 +187,58 @@ After a minute or so a preview deployment of your use case will be available on -### 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) | +### 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 - - --- - - - - {% 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": - Bottommost include may be different since last update. - -2. Add an include to your document in the same way: - - ```md - - --- - - - - {% include-markdown 'your-usecase/usecase.md' %} + ```diff + - Wind and Storm Surge: + - ... + + - Your Use Case: your-usecase/usecase.md ``` - Edit this include to point to your use case. + Edit the new line to reflect your use case. [DS-User-Guide]: https://github.com/DesignSafe-CI/DS-User-Guide/ [DS_Use_Case_template]: https://github.com/DesignSafe-CI/DS_Use_Case_template/