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

Bugfix/fp 1542 do not use a2cps url #493

Merged
merged 7 commits into from
May 25, 2022

Conversation

wesleyboar
Copy link
Member

@wesleyboar wesleyboar commented May 24, 2022

Overview

Use local images for Data Transfer guides.

Related

Changes

  • [fix] add and use images
  • [enhancement] add extra example images I found
  • [fix] tweak image max-width

Testing

Confirm images:

  • are not loaded from a2cps-staging
  • are not wider than the image max width*
  • are not excessively large
  • are not rendered larger than intrinsic dimensions†

* The default guide max image width is 800px, but Data Transfer page sets 670px max image width.
† Some of the images are just bad quality.

Remote

build job & deploy job

Local

  1. Be able to Test CMS Changes.
    • remember to collectstatic (to provide the local images to Django)
  2. Add page/s set to use these templates:
    • "Guide: Globus Data Transfer"
    • "Guide: Data Transfer"

Screenshots

Data Transfer Globus Data Transfer
FP-1542-data-transfer FP-1542-globus-data-transfer

Notes

✓ To Do

Copy link
Member Author

@wesleyboar wesleyboar left a comment

Choose a reason for hiding this comment

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

Notes for reviewers.


{% block guide %}
<style>
/* To override 800px (from stylesheet) which is too big for these images */
.s-document img {
max-width: 570px;
max-width: 670px;
Copy link
Member Author

@wesleyboar wesleyboar May 24, 2022

Choose a reason for hiding this comment

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

Explanation. Image text in Data Transfer's bottom-most image was easier to read if a bit larger.

Copy link
Member Author

@wesleyboar wesleyboar left a comment

Choose a reason for hiding this comment

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

Note for reviewer since updated core-styles commit.

"resolved": "git+https://git@github.com/TACC/Core-Styles.git#16c8873586785344ebd84b8360584c5a390bc499",
"resolved": "git+https://git@github.com/TACC/Core-Styles.git#ed1e102ffea902142845924c0c5357794e2117b6",
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. To get fix from TACC/Core-Styles#25.

@wesleyboar wesleyboar marked this pull request as ready for review May 24, 2022 20:27
@wesleyboar wesleyboar requested review from fnets and taoteg May 24, 2022 21:24
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.

Would it be useful to scrub (or blur) the A2CPS from the paths in these images and replace it with {PROJECT}, so as not to confuse anyone referencing them?

A similar concern with the right-side of this image:

Otherwise, LGTM as far as functional changes go.
Approving as is, up to you on the above concerns.

It would be ideal if we had fresh clean screens from a dummy user actually setting everything up on current systems... but that's probably a bridge too far at this time. Maybe in the v3 iteration. =)

@wesleyboar
Copy link
Member Author

Test URLs fixed:

These will be good unless I need to deploy something else to dev.cep and am too lazy to create a branch with multiple features.

Copy link
Contributor

@fnets fnets left a comment

Choose a reason for hiding this comment

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

LGTM! Great job, this looks a lot cleaner. Personally, I guess I'd prefer that the guide be a little more portal-agnostic like John said. But, I think that's outside the scope for this particular ticket.

@wesleyboar
Copy link
Member Author

I just read those suggestions. Sounds good. I'll come back to it this week.

@taoteg
Copy link
Collaborator

taoteg commented May 25, 2022

Preface: This all looks great and I don't know if this is in the scope of this PR, but...

While comparing the Data Transfer Guide to the Globus Guide, I noticed that only the images in the Data Transfer Guide have indentation. Could we either A) make all guide images left-aligned or B) make all the guide images centered, with the outcome in either choice being consistent design across both the guides?

I would vote for option B (tweak the Globus Guide layout to match the Data Transfer Guide layout by using centered images).

@wesleyboar
Copy link
Member Author

It is out of scope for this bug fix, but there's also some typography bothering Hedda and I, so I want to add some miscellaneous updates in a follow-up ticket; I'll add your image alignment notes to it.

@wesleyboar
Copy link
Member Author

Images have had project names blurred out (b16bb9f).1 I have not re-deployed.

Image alignment has been added to new ticket for Guide page inconsistencies: FP-1676. An existing ticket will add breadcrumbs: FP-1452.2

Footnotes

  1. Replacing specific project name with {PROJECT} proved difficult to do attractively (match unknown font, fit in narrow gap).

  2. Non-crucial changes are low priority, because these Guides pages are supposed to be moved out to TUP documentation (or that's what I remember from a documentation meeting this year). But I do want to improve consistency, and needed to create a ticket for things I've noticed.

@wesleyboar wesleyboar merged commit eb1cd94 into main May 25, 2022
@wesleyboar wesleyboar deleted the bugfix/FP-1542-do-not-use-a2cps-url branch May 25, 2022 22:38
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