GH-75: Data List - Plugin

[wesleyboar]

To Do

• Use get() not direct indexing.
• (Optional) Resolve list comprehension legibility.

Overview

Implement "Data List" plugin.

Issues

• "Data List" Table (for System Specs) - Styles & Plugin #75

Changes

• Create plugin for UI component.

Screenshots

Form

Plugin	Image
Data List
Data List Item	old screenshot
Link	either "Generic" > "Link" or "Bootstrap 4" > "Link / Button"

Render

Structure

Testing

Last recorded deploy to Frontera (dev) was Build #392 (Aug 9, 2021 1:02:37 PM).

Last recorded deploy to Core (dev) was Build #393 (Aug 9, 2021 1:04:25 PM).

1. If no environment, then prepare to test CMS changes.
2. In CMS container, run python3 manage.py migrate.
3. On CMS website, logged in as admin, add "TACC Site" > "Data List" plugin.
4. Within the "Data List" plugin, add "TACC Site" > "Data List Item" plugin.
5. Ensure the following:
   1. each config value changes/adds a classname on the root element from the snippet markup (classname/config map)
   2. plugin description (next to name) in Structure view describes the required config values (short_desc/config map)
   3. labels and values added (via "Data List Item" plugins) are rendered
      • ✱ and an empty Label field results in no label text (an empty label spot)
   4. styles match those from GH-75: Data List - Styles / Component #305
      • ✱ but more space above & below between Table label/value cells
6. Within a "Data List Item":
   1. ✱ confirm "Link" fieldset instructions render well and make sense
   2. confirm "Advanced settings" > "Support child plugin for Label" is checked
   3. † add a "Generic" > "Link" or "Bootstrap 4" > "Link / Button"‡ plugin
7. † Confirm label becomes the link you added.
8. Add "Generic" > "Text" plugin.
9. In Text plugin, in "CMS Plugins" dropdown, confirm these new plugins are not available:
   1. "TACC Site" > "Data List"
   2. "TACC Site" > "Data List Item"

✱ Step added since initial review.
† Step requires testing on a branch into which task/GH-75-plugin and quick/support-plugins-unadulterated-by-bootstrap--for-main have been merged.
‡ Removed since initial review, because this plugin is not supported in this PR.

[wesleyboar]

Added notes.

[iamthatian]

Everything works!
I had some small python style comments.

[wesleyboar]

@duckonomy I've added three commits (one new test step each).*

• e224ea6 Instruct user in "Data List Item" how to add a link.
  • new test step: 6.i.
  • updated screenshot
• a7c6ae4 Allow empty Label field in "Data List Item" so user can quickly add link.
  • new test step: 5.iii.
• 4fbf1e2 Add missing vertical padding to "Data List Item" in Table "Data List".
  • new test step: 5.iv.

* Sorry to add more after you've already reviewed. This PR is meant to support GH-88 which has a Data List component. I'd like to do it all well on the first attempt if I know how.

[wesleyboar]

@duckonomy The remaining review tasks are (a) checking my resolution of your items from your previous review and (b) the three new features (sorry, these came up as I re-reviewed the UX and UI while testing integration into GH-88).

1. Use get() not direct indexing.
2. (Optional) Resolve list comprehension legibility.
3. See e224ea6 and three new commits (for details).
4. See a7c6ae4 and three new commits (for details).
5. See 4fbf1e2 and three new commits (for details).

[iamthatian]

Functionality-wise LGTM!

I've spotted a few typos but will approve!

[wesleyboar]

Thanks, @duckonomy. I've committed the changes, and tested* them.

* (via manual integration test on site/frontera/task/GH-75-plugin—cherry-picks commits from task/GH-75-plugin)