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

Task/fp 862 load branding from cms #334

Merged
merged 10 commits into from
Jan 28, 2021

Conversation

wesleyboar
Copy link
Member

@wesleyboar wesleyboar commented Jan 27, 2021

Overview:

Load branding bar and nav bar logo from CMS.*

* CMS is not the long-term location to store header components, but at least the code is DRY-er this way than before.

PR Status:

  • Ready.

Related Jira tickets:

FP-862

Related PRs:

Summary of Changes:

  • New: Update Docker image tags for CMS & Docs.
  • Minor: Remove outdated and now unnecessary Portal settings.
  • Minor: Rename template from navigation.html to header.html.
  • New: The header.html includes new header_logo.html and header_branding.html.
  • New: The branding and logo are loaded from CMS using near-identical code.

Testing Steps:

⚠︎ @tacc-wbomar has not yet tested via fresh containers and images. He tested using rsync and extra docker volumes (tricks not yet fully documented).

How to Test

See How to Test Portal/CMS/Docs Compatibility.

What to Test

  1. The branding bar (top half of header) is 49px tall* (including border)…
    • on wide screen,
    • and on narrow screen.†
  2. The navigation bar (bottom half of header) is 50px tall…
    • on wide screen,
    • and on narrow screen.†
  3. On a narrow screen†, menu reveal matches dev.fronteraweb (or, if you test Core, dev.cep).
  4. After header content load, the branding bar matches exactly across CMS, Portal, and User Guide.
  5. After header content load, the logo matches exactly across CMS, Portal, and User Guide.
  6. While header content dynamically loads, the branding bar and navigation bar are not resized.

* A 50px height including border is a "nice-to-have". I am saving small changes like that for the redesign (part of which is done by TACC/Core-CMS#29), during which I will greatly re-arrange styles for the better.

† A "narrow screen" is less than 1200px wide. At this screen width the navigation is hidden within a header that can be resized by clicking a toggle.

UI Photos:

Frontera

Frontera CMS
FP-862 Frontera CMS

Frontera Portal
FP-862 Frontera Portal

Frontera Docs
FP-862 Frontera Docs
(Search Field and Portal Nav are pushed to the left because of scroll bar.)

Core

Core CMS
FP-862 Core CMS
(Search Field being too large is a Known Issue. See TACC/Core-CMS#62.)

Core Portal
FP-862 Core Portal

"Core" Docs
FP-862 Core Docs
(Search Field and Portal Nav are pushed to the left because of scroll bar.)

Notes:

Known Issues

Search Field is too large on Core CMS.

FP-862 Core CMS
See TACC/Core-CMS#62.

On narrow screen, with expanded nav menu, highlight of last CMS nav menu item is hidden by Search Bar.

Any - Narrow Width - Open Dropdown Highlight Last CMS Item
Also permitted in #290. (Should be fixed during redesign.)

Disclaimer: Screenshot is from #290.

@codecov
Copy link

codecov bot commented Jan 27, 2021

Codecov Report

Merging #334 (04e0fb2) into master (01d58cb) will increase coverage by 0.00%.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #334   +/-   ##
=======================================
  Coverage   62.13%   62.13%           
=======================================
  Files         371      371           
  Lines       11413    11409    -4     
  Branches     1858     1858           
=======================================
- Hits         7091     7089    -2     
+ Misses       4024     4022    -2     
  Partials      298      298           
Flag Coverage Δ
javascript 63.53% <ø> (ø)
unittests 61.22% <ø> (+<0.01%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
server/portal/settings/settings.py 0.00% <ø> (ø)
server/portal/settings/unit_test_settings.py 99.02% <ø> (-0.02%) ⬇️

@wesleyboar wesleyboar marked this pull request as ready for review January 27, 2021 23:08
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.

Looks good! Is the relevant code also in core-cms?

Copy link
Collaborator

@taoteg taoteg left a comment

Choose a reason for hiding this comment

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

LGTM. I verified the image hashes are published in dockerhub too, so G2G!

@wesleyboar wesleyboar merged commit ed689e9 into master Jan 28, 2021
@wesleyboar wesleyboar deleted the task/FP-862-load-branding-from-cms branch January 28, 2021 21:06
@wesleyboar
Copy link
Member Author

Looks good! Is the relevant code also in core-cms?

Late public answer. Yes. See "Related PRs", specifically TACC/Core-CMS#63.

wesleyboar added a commit that referenced this pull request Jan 7, 2022
* FP-862: Load branding & logo from CMS (untested)

* FP-862: Rename branding.html to header.html

* FP-862: Remove unused settings (CMS manages, now)

* FP-862: Remove header tempalte cruft

* FP-862: Update CMS and Docs image tags

* FP-862: Update CMS tag (style tweak)

* FP-862: Update CMS tag (style fix)
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.

3 participants