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

GH-195: Clone Portal Nav #211

Merged
merged 4 commits into from
Apr 29, 2021
Merged

Conversation

wesleyboar
Copy link
Member

@wesleyboar wesleyboar commented Apr 27, 2021

Status

Postponing merge to ensure no other Portal CMS accidentally deploys this without TACC/Core-Portal PR #390.

Overview

Replace replicated Portal nav template code and unique update script with common code to load external markup.

Related

Issues

PRs

Changes

  • Minor: Add comment about deprecation of nav_portal.js.
  • New: Replace Portal nav markup with use of importHTML to load nav from Portal.

Testing

Notice: Local testing should not be necessary if this and related code is deployed to Frontera Dev via FP-1032.

  1. Test on dev.fronteraweb.tacc.utexas.edu or local environment (instructions).
  2. For CMS & Docs:
    1. If not logged in, then portal nav should load as "Log in" link.
  3. For CMS & Portal & Docs:
    1. If logged in, then portal nav should load as "[username]" dropdown menu link.
    2. If logged in, then dropdown menu link should able able to open and close as it has.
    3. When loading page with no browser cache, portal nav should not load too much later than search.*
  4. For Docs:
    1. Ensure header text is white, not gray.
  5. For Portal:
    1. (As of 2020-04-28, this feature is not yet available to test on dev.fronteraweb.tacc.utexas.edu.)
      When logged in as staff, confirm "Onboarding Admin" is in the portal nav dropdown for staff (how to become staff).
Footnotes

* Were it to load too much later, then the user experience is affected. Loading less than a second later (if not at the same time or earlier) is acceptable (confirmed with Design via video comparison). The solution, were it to load too much later, may be to animate its appearance such that it slides in from the right, pushing search to the left to make space for itself. Branch with animation solution is task/FP-1015-GH-195-clone-portal-nav--animate-load.

Screenshots

CMS

Local CMS

Videos
Local.CMS.Fast.mov
Local.CMS.Slow.mov

Portal

Local Portal

Videos
Local.Portal.Fast.mov
Local.Portal.Slow.mov

Docs

Local Docs

Videos
Local.Docs.Fast.mov
Local.Docs.Slow.mov

Onboarding Admin

This new link requires (A) latest of Portal branch (since TACC/Core-Portal@f82b29b) and (B) that your user is staff.

Onboarding Admin

Notes

Please mention discrepancies you may notice beyond the loading of the Portal nav, but unless it is related to the code change, such discrepancies will likely be recorded for another ticket to resolve.

Known Issues
Existing Tickets


/* RFC: If we dynamically load isolated nav DOM from Portal, then do we need this solution? */
/* SEE: https://github.com/TACC/Frontera-Portal/blob/d4c3895/server/portal/templates/includes/navigation.html#L78-L92 */
/* WARNING: This code is deprecated. It must be removed AFTER GH-195/FP-1015. */
Copy link
Member Author

Choose a reason for hiding this comment

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

Explanation
This file is kept temporarily in case a misfire deploy does not deploy the desired Docs image and Docs is still looking for this.

Copy link
Member

@rstijerina rstijerina left a comment

Choose a reason for hiding this comment

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

LGTM

@wesleyboar
Copy link
Member Author

wesleyboar commented Apr 29, 2021

Postponing merge to ensure no other Portal CMS accidentally deploys this without TACC/Core-Portal#390. For more information, see "Status" (at the top of this comment's PR).

@wesleyboar wesleyboar merged commit 7066822 into main Apr 29, 2021
@wesleyboar
Copy link
Member Author

Considering reasonably safe to merge because deploys are pinned to docker tags (so don't default to bleeding edge main), and 3dem and Frontera and Core deploy process is managed by @rstijerina who is aware of this dependency, and ProTX is unlikely to have a re-deploy of CMS without Portal (because I am currently the one building CMS docker images for ProTX and I am aware of the dependency).

@wesleyboar wesleyboar deleted the task/FP-1015-GH-195-clone-portal-nav branch April 29, 2021 20:38
@wesleyboar wesleyboar linked an issue Apr 29, 2021 that may be closed by this pull request
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.

CMS & Docs to Clone—not Recreate—Portal Nav
2 participants