department-of-veterans-affairs / va.gov-cms

Editor-centered management for Veteran-centered content.
https://prod.cms.va.gov
GNU General Public License v2.0
99 stars 69 forks source link

VAMC Detail page: adopt V1 and V3 components where components are not used #16999

Closed laflannery closed 5 months ago

laflannery commented 9 months ago

Description

VAMC Detail pages need the following updates to components:

Example pages:

Elements that are not using components that should be (Backlog)

  1. Link
  2. ~Telephone~
  3. ~Featured content~
  4. Additional Info
    • This is what this looks like when an editor adds this: Screenshot 2024-05-16 at 9 47 26 AM
    • And this is the markup: Screenshot 2024-05-16 at 9 49 05 AM
    • Drupal Fields: Screenshot 2024-05-16 at 9 54 42 AM
    • Because the trigger text and the content are separate elements, maybe we can update this to be a component?
  5. Back to top component
    • Update 5/3: After determining that this component does not actually have built in intelligence to only show based on page height:
      • This should still be added, a lot of the Detail pages are often quite long. The benefit of including this component outweighs (in my opinion) the times when it would show on short pages and it would be an extra tab stop or an extra visual element.
  6. Process list
    • If we can use the the v3 component we should but this may not be possible because it's CMS content
    • Screenshots of what this looks like to determine if we can make this a component:
      • Visual display: Screenshot 2024-05-16 at 9 50 44 AM
      • Markup: Also, note that in this it looks like the <h2> and <p> might be coming from separate Drupal fields but that's not the case, it's one rich text field Screenshot 2024-05-16 at 9 51 40 AM
      • Drupal: Since I realized this might be helpful as well Screenshot 2024-05-16 at 9 54 35 AM

Not in scope: V1 components that need to be upgraded: handled in separate tickets

  1. ~Accordion~
    • ~Accordion sections are using the v1 component and need to be updated to v3~
  2. ~Alert~
    • ~Currently using the v1 component but needs to be updated to v3.~
  3. ~Button~
    • ~It is inside the alert and is currently using the v1 component but needs to be updated to v3.~

Acceptance Criteria

Team

Please check the team(s) that will do this work.

maxx1128 commented 8 months ago

I would estimate this ticket at a 5 since it's a relatively simple page, but there are a lot of components that need to be added, updated, and checked afterward. It is all static content and nothing too complicated, which is why I don't think it would be an 8 or higher.

laflannery commented 7 months ago

I struck out the featured content/summary box component update because we aren't able to do this - the content coming from drupal does not fit what the component needs. Full details of this issue in the comment here

I also updated Link, Phone, and Process list because since this is CMS content, updating these may not be possible.

laflannery commented 7 months ago

Alert and button are already v3, I believe it happened with this PW ticket Screenshot 2024-03-27 at 11 41 19 AM

laflannery commented 7 months ago

Accordions are also using v3 already Screenshot 2024-03-27 at 11 42 47 AM Screenshot 2024-03-27 at 11 43 51 AM

I will try to track down the ticket/s where this happened

laflannery commented 7 months ago

Telephone moved to #16148

eselkin commented 6 months ago

@laflannery Where is the additional info component needed? I can't find anything about additional info on the linked pages. I see one additional info section that's in https://www.va.gov/boston-health-care/contact-us/ for FOIA requests, but that's drupal wysiwyg content.

Also, not sure where we'd use the process list, it appears it is Drupal content you're probably talking about because most stuff (90%) on the Detail page is CMS content.

Just for links and back-to-top this is likely a 3.

laflannery commented 6 months ago

Answers below @eselkin!

eselkin commented 6 months ago

@laflannery Do you mean the "How do I talk to someone right now?" alert that has the fake expandable "Find out how to get support anytime, day or night." toggle that should be and additional info component, but is not. Let me look at the paragraph to see how the additional info gets processed.

Ok, that alert is processed with the block alert (src/site/blocks/alert.drupal.liquid) not the paragraph alert. So that just needs to get updated to use the additional info component. Not too hard.

eselkin commented 6 months ago

There's a paragraphs/process which I'm guessing is supposed to be a process list but not sure. It would not be that hard to convert. Though with the prior change and this change would likely be at least a 5 in terms of checking we aren't breaking things and that they look ok.

eselkin commented 6 months ago

There's a paragraphs/process which I'm guessing is supposed to be a process list but not sure. It would not be that hard to convert. Though with the prior change and this change would likely be at least a 5 in terms of checking we aren't breaking things and that they look ok.

@omahane @davidmpickett is there some view or something where we can see if the entity_bundle process is getting used on a detail page somewhere?

laflannery commented 6 months ago
  1. It sounds like we can do the process list - yay! Re: your questions above - I just added one for you to confirm, is that what you needed? Screenshot 2024-04-24 at 5 21 53 PM
  2. Is sounds like we can do the additional info content inside an alert - yay again!
  3. Did we confirm if we can also do the paragraphs/spanish_translation content as well?
davidmpickett commented 6 months ago

@eselkin So the Detail page Content type is unique in that it has lots of optional paragraphs types that could be added. I don't think there is an easy way to get a report of which VAMC Detail pages use which paragraph types. But @omahane might have an idea for a magical View.

A more likely path to testing would be to create a test VAMC Detail Page that uses 1 of each possible Paragraph type so you have an example that covers all the scnearios rather than trying to hunt for one in the wild.

davidmpickett commented 6 months ago

Not sure if this helps, but here's an example from PW of a page using the Process List in Drupal and the Corresponding FE.

laflannery commented 6 months ago

I just want to make sure we aren’t making this too complicated - I have already gone through the VAMC detail pages to determine what blocks/content can and cannot be added, that’s how this ticket was created. So that shouldn’t need to be done again

I also created the Process list on a VAMC page in my previous comment and that’s what we should be using here. Content from a different page may not be exact so the first example would Probably be best

eselkin commented 6 months ago

@laflannery sorry, I didn't see the process list there. I just was wondering if there was a location to test on a detail page in existance. You creating one is just as good! Thanks! The spanish translation summary really should just include the expandable additional info component because it's literally the same exact code. No idea why there's a duplicate of that block. Yes, that'd be included in that 5 estimate then.

davidmpickett commented 6 months ago

I also created the Process list on a VAMC page in my previous comment and that’s what we should be using here. Content from a different page may not be exact so the first example would Probably be best

Can you add a link to that VAMC page to the ticket body under Process List (like you did for the video link example) so it's easy to find for QA & validation?

jilladams commented 6 months ago

Rather than divide this ticket to address only icon related things first, and the rest of componentizing later, we'll just do the components along with the icon work.

jilladams commented 6 months ago

For Additional Info & Process list: @laflannery can generate test content on staging and provide screenshot of the HTML markup from Preview, to make this easier.

laflannery commented 6 months ago

Screenshots added to description, For whomever picks this up, let me know if anything else is needed I can get you

randimays commented 5 months ago

@laflannery I read through the comments but I'm not clear where we landed on a test page for process list.

Do you know of a production page that uses the process list already? If not, I'll spin up a Tugboat and add one to an existing page.

laflannery commented 5 months ago

Sorry @randimays I had added screenshots of the markup I got from preview into the ticket description. There are production benefit detail pages (example) that use a process list but I don't know of a VAMC detail page that uses this currently.

randimays commented 5 months ago

This will be posted for review today. It most likely won't make the production deploy, so it will carry over to tomorrow.

randimays commented 5 months ago

Successfully validated in production. Closing!