DesignSafe-CI / DS-User-Guide

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

feat: des-2792 migrate OpenSees app desc from portal #15

Closed wesleyboar closed 1 month ago

wesleyboar commented 1 month ago

Overview

Migrate DS Workspace: OpenSees instructions to DS User Guide: OpenSees.

Background The [DS Workspace](https://www.designsafe-ci.org/rw/workspace/) is being redesigned. Add descriptions have been moved, but not yet OpenSees' instructions within its app description.

Related

Changes

Testing

  1. Run application.
  2. Open http://0.0.0.0:8000/user-guide/tools/simulation/opensees/opensees/.
  3. Under "OpenSees on DesignSafe", find

    Abbreviated User Guide: OpenSees On DesignSafe Quick Start

  4. Click link.
  5. Compare document to documentation at https://www.designsafe-ci.org/rw/workspace/#!/OpenSees::Simulation.

UI

OpenSees on DesignSafe OpenSees on DesignSafe: Quick Start
new link ds os qs 1
ds os qs 2
ds os qs 3

Notes

[!NOTE] The <details> element will be available after #1, so we can do:

Instructions

1. … 2. … 3. …
wesleyboar commented 1 month ago

@silviamazzoni, I will add you as reviewer when admin approves. For now, feel free to review and comment if able. If you would rather create your own PR, go for it. I could merge this in, without linking to it, then link to it when you are satisfied.

silviamazzoni commented 1 month ago

Wes, looking at the image on the right, I don't see the OpenSees opened up on the left. I recommend you add it as the very first subsection to OpenSees on DesignSafe. thank you for doing the conversion. i am guessing that once you receive approval, go ahead and merge it, and then I can from that. thank you

wesleyboar commented 1 month ago

@silviamazzoni, update:

  1. "Quick Start" now included (not linked) as "OpenSees-on-DesignSafe Quick Start". Heading depth updated accordingly.
  2. Lists that had used "A. B. C." now do again.
  3. Left comments about when and how we can use <details>. (basically: not yet, but soon, via /// details | Instructions)
wesleyboar commented 1 month ago

You're welcome to make further updates.

silviamazzoni commented 1 month ago

yes, once your work is fully merged I will update my end.