Skip to content

Conversation

wesleyboar
Copy link
Collaborator

@wesleyboar wesleyboar commented Sep 22, 2025

Overview

Add plugin to render User Guide link on CMS app overview page.

Status

Tip

Tested locally.

Related

Changes

  • added CMS plugin and its model and admin form
  • added function to derive app from URL path
  • added function to know whether context is editing Text

Testing & UI

  1. Create/Find an App Listing Entry with an href value.
    E.g. Ground-Motion Portal app. Scroll to "CMS Display Options:".

    1
  2. Create/Open page at a path that matches one of an App Listing Entry.
    E.g. /use-designsafe/tools-applications/hazard-apps/ground-motion-portal/.

    2
  3. On page, add "User Guide Link" plugin; do not choose app.

  4. Verify link is rendered that opens page at correct path for User Guide.
    E.g. /user-guide/tools/hazard/#scec.

    3-4.mov
  5. Change page path to one that does not match an app.

  6. Verify:

    • link is not rendered
    • text "User guide not found." is rendered
    • server does not crash
    5-6.mov
  7. Change "User Guide Link" plugin; choose app.

  8. Verify button URL is for the app chosen.

    7-8.mov

Notes

The new function get_instance_from_url could be used by existing plugins, RelatedApps and AppVariants, so that their models, AppVariantsPlugin and RelatedAppsPlugin, need not be used.

@wesleyboar wesleyboar marked this pull request as draft September 22, 2025 18:15
@wesleyboar wesleyboar marked this pull request as ready for review September 23, 2025 16:47
@wesleyboar wesleyboar changed the title feat: DSAPP-106 CMS user guide link from app model feat: DSAPP-106 CMS Plugin for User Guide Link Sep 23, 2025
…github.com:DesignSafe-CI/portal into feat/DSAPP-106-cms-page-user_guide_link-from-model
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant