search

DesignSafe-CI / DS-User-Guide

User Guide for DesignSafe
https://www.designsafe-ci.org/user-guide/
0 stars 8 forks source link

use cases: broke down into separate files and fixed some headers that… #63

Closed silviamazzoni closed 3 months ago

silviamazzoni commented 3 months ago

Overview

Broke down Use Cases into separate files and fixed some headers that had not been updated.

Testing

We do need to check the links from the nav because they want to connect to an anchor, not a file, which is how they are set up now.

UI

since TACC-Docs v0.10 https://github.com/user-attachments/assets/8434be01-9e57-4f45-802a-5ede69007492 https://github.com/user-attachments/assets/fb1ad5c6-a1a2-4285-8ad1-2d9ace5944d2
using TACC-Docs v0.8 sample document header https://github.com/user-attachments/assets/0424e5ed-fd37-4ae7-91a6-fa563a4ee86e detailed nav is automatically open https://github.com/user-attachments/assets/33460a86-5a78-42d3-808b-d88ff90e9485

edited by @wesleyboar (organized and added visuals)

netlify[bot] commented 3 months ago

Deploy Preview for ds-user-guide failed. Why did it fail? →

Name Link
Latest commit ce7eec504e5f8a7ca79998bf7e4e0e6f6b4b794b
Latest deploy log https://app.netlify.com/sites/ds-user-guide/deploys/669b057cf3b5d800082b8341
wesleyboar commented 3 months ago

There are navigation bugs when using flat navigation. Reported in DES-3045. Expect solution via TACC-Docs update.

wesleyboar commented 3 months ago

[!TIP] If testing via Docker, there are no navigation bugs introduced by this change.

[!CAUTION] If testing via Python, several navigation bugs are introduced by this change.

silviamazzoni commented 3 months ago

Wes, do you have an update on this?

wesleyboar commented 3 months ago

No update. Same status as it was in https://github.com/DesignSafe-CI/DS-User-Guide/pull/63#pullrequestreview-2202873603. I've been taken by DesignSafe website work and another project. Still an excellent PR. I don't mind it staying open, let's me know what is still waiting on me.

If you are okay with the nav bugs for Python-based testing, please tell and reopen so I can merge. Otherwise, this would wait until have time to solve https://github.com/DesignSafe-CI/DS-User-Guide/issues/66.

silviamazzoni commented 3 months ago

The nav bugs are are only on my testing end, correct? And they are just style bugs? The public version of the docs would be perfect and have the separated docs, correct? If I want to replicate the site locally exactly, I'd have to use the docker, correct? If so, yes, please accept this PR.

wesleyboar commented 3 months ago

Yes x4. Merged.