Add a dashboard to the Accessibility Tools recipe

Created on 6 November 2024, 9 months ago

Problem/Motivation

Based on the concept created in the Specification document for providing accessibility tools in Drupal CMS, the current drupal_cms_accessibility_tools recipe should be expanded to include a dashboard.

Until more tools can be made available, this can be quite basic to start with and then revisions made, if required.

Steps to reproduce

Login and enable the Accessibility Tools recipe.
Go to the Dashboards page and view the available dashboards.

Proposed resolution

Provide a dashboard.

Remaining tasks

Create it and add it to the current recipe.

User interface changes

A dashboard will be available in the dashboards page when the Accessibility Tools recipe is enabled. This will provide links to common accessibility tasks and services.

✨ Feature request
Status

Active

Component

Track: Accessibility Tools

Created by

πŸ‡¬πŸ‡§United Kingdom the_g_bomb

Live updates comments and jobs are added and updated live.
Sign in to follow issues

Merge Requests

Comments & Activities

  • Issue created by @the_g_bomb
  • πŸ‡¬πŸ‡§United Kingdom the_g_bomb
  • Pipeline finished with Canceled
    9 months ago
    #331003
  • πŸ‡¬πŸ‡§United Kingdom the_g_bomb
  • Pipeline finished with Failed
    9 months ago
    #331006
  • Pipeline finished with Success
    9 months ago
    #331005
  • πŸ‡ΊπŸ‡ΈUnited States phenaproxima Massachusetts

    There are no real technical problems here, but the dependencies on core recipes pose some issues that you didn't cause, but we still have to figure out, before I can commit this.

  • πŸ‡¬πŸ‡§United Kingdom the_g_bomb

    I'll give it a blast to make the change requested. I was trying to follow the style of the SEO Dashboard, so I think the Full HTML is possibly only to allow the addition of a class to the a tag. If I alter the existing Basic HTML filter to add the class attribute to the allowed list. That would remove the need for the use of Full HTML.

  • Pipeline finished with Failed
    8 months ago
    Total: 675s
    #340240
  • Pipeline finished with Failed
    8 months ago
    Total: 731s
    #340241
  • πŸ‡¬πŸ‡§United Kingdom the_g_bomb

    I removed the dependency on the image format, it wasn't needed.
    I also changed the full_html dependency to the existing easy_email and it hasn't got the "Limit allowed HTML tags" which removed the needed class.

  • πŸ‡ΊπŸ‡ΈUnited States phenaproxima Massachusetts

    Seems reasonable but we should not be relying on the easy_email format. It's for emails.

  • Pipeline finished with Failed
    8 months ago
    Total: 558s
    #340255
  • Pipeline finished with Failed
    8 months ago
    Total: 667s
    #340256
  • Pipeline finished with Failed
    8 months ago
    Total: 394s
    #340278
  • Pipeline finished with Failed
    8 months ago
    Total: 428s
    #340279
  • Pipeline finished with Failed
    8 months ago
    Total: 653s
    #340289
  • Pipeline finished with Failed
    8 months ago
    Total: 668s
    #340290
  • πŸ‡¬πŸ‡§United Kingdom the_g_bomb
  • πŸ‡ΊπŸ‡ΈUnited States phenaproxima Massachusetts

    Looks good to me from a code perspective; assigning to @pameeela for final review.

  • πŸ‡¦πŸ‡ΊAustralia pameeela

    I'm quite hesitant to add another dashboard that really only contains links, and I need to run this by the UX team.

    Separately the text format issue is a real problem! Definitely don't want to add basic_html for blocks on a dashboard, and now I see that Full HTML was added back for a different dashboard..... yikes.

  • πŸ‡¬πŸ‡§United Kingdom the_g_bomb

    Happy to park this. The intention is to have a content view here, which will show accessibility issues with a users content. But the module that provides that isn't in existence yet, so I can re-address this when the view is available.

  • πŸ‡¦πŸ‡ΊAustralia pameeela

    @the_g_bomb yes basically I think that's what we should do, wait until we have the content view.

    But I also think this might be suitable to add to the main dashboard, rather than having a separate one for that.

  • πŸ‡ͺπŸ‡ΈSpain penyaskito Seville πŸ’ƒ, Spain πŸ‡ͺπŸ‡Έ, UTC+2 πŸ‡ͺπŸ‡Ί

    Once ✨ Provide a Config Action to add/edit a component in a layout Active lands, the recipe could just add a block to the welcome dashboard.

    For that instead of a list of links, we decided to use menus in πŸ“Œ Define how wireframes links block on the right should be created Active . Probably we want to use the same here.
    This depends on ✨ Render menus as a list of CTAs Active landing on the dashboard module. This will create a stacked vertical list of links, not sure if you intended this to be horizontal.

    That will be implemented for the creation actions in πŸ“Œ Provide a "Dashboard CTA" menu for the content creation CTAs Active (no MR yet, sorry)

  • πŸ‡¦πŸ‡ΊAustralia pameeela
  • Issue was unassigned.
  • Status changed to Postponed about 1 month ago
  • πŸ‡¬πŸ‡§United Kingdom the_g_bomb

    FYI, There is now a way to create a list of content and display the A11y issues status, so I may like to bring this out of postponment if there is still appetite for an A11y related block on a Dashboard.

    At first thoughts I would wonder how that would be applied to an existing dashboard. Does the recipe need to know where on Dashboard it is going to be applied, given that the Accessibility Tools are an optional recipe and will likely be enabled after everything else has been setup.

  • πŸ‡ΊπŸ‡ΈUnited States thejimbirch Cape Cod, Massachusetts

    This change record has details on the config action you would use to add it.

    https://www.drupal.org/node/3519491 β†’

  • πŸ‡ΊπŸ‡ΈUnited States phenaproxima Massachusetts

    I'm happy to pull this out of postponement. We'd need to do additional refactoring to move the dashboard into another module (maybe drupal_cms_admin_ui, so that drupal_cms_accessibility_tools could depend on it) but that could all happen in this issue's scope. For now, implement it in whatever way gets it looking and working how you want. I can assist with the refactoring.

  • πŸ‡¬πŸ‡§United Kingdom the_g_bomb

    the_g_bomb β†’ changed the visibility of the branch 3485831- to hidden.

  • πŸ‡¬πŸ‡§United Kingdom the_g_bomb

    the_g_bomb β†’ changed the visibility of the branch 0.x to hidden.

  • πŸ‡¬πŸ‡§United Kingdom the_g_bomb

    the_g_bomb β†’ changed the visibility of the branch 2.x to hidden.

  • πŸ‡¬πŸ‡§United Kingdom the_g_bomb

    Thanks for the pointer @thejimbirch. Nice and straightforward.
    The only bit I wasn't clear on was how to determine the position.
    Is that used instead of weight? (I noted it says weight will be automatically calculated)
    What happens if another recipe chooses the same position?

  • πŸ‡¬πŸ‡§United Kingdom the_g_bomb
  • Pipeline finished with Failed
    22 days ago
    Total: 1067s
    #535324
  • πŸ‡ΊπŸ‡ΈUnited States phenaproxima Massachusetts

    That looks like a good start but it's missing a dependency and it needs light test coverage.

  • πŸ‡¬πŸ‡§United Kingdom the_g_bomb
  • Pipeline finished with Failed
    21 days ago
    Total: 899s
    #536270
  • πŸ‡ΊπŸ‡ΈUnited States phenaproxima Massachusetts

    The dependency changes look right but the test should approach the dashboard from a functional end-user perspective. :)

  • πŸ‡ΊπŸ‡ΈUnited States phenaproxima Massachusetts

    I tried this out and I think it could be better. Here's what I see in the dashboard after applying the recipe (in the Tugboat preview):

    If I was a content author or editor, I would have no idea what this meant or what it was doing there. The lowercasing of "url" looks unprofessional (and is a technical word anyway). The button is unreadable. There's nothing in the block, and no explanatory text. Clicking the button brings me to an equally inscrutable page.

    I'll commit this if @pameeela feels it would be beneficial, but I'm not sure we should release this in its current state.

  • πŸ‡¦πŸ‡ΊAustralia pameeela

    Thank you for the screenshot @phenaproxima! Agree this is not commit-able in its current state, but to be fair it would probably be good to provide some specific advice.

    But I think this also needs an IS update because the current proposal is to add a block to the existing dashboard. @the_g_bomb are you able to update it with a description of how this block works and what it is intended to provide to the user?

  • πŸ‡¬πŸ‡§United Kingdom the_g_bomb

    This is an upstream issue from Editoria11y. I'll open a ticket to amend the block titles and make them more usable.

    This is essentially the out-of-the-box "No results behavior"

    This block shows the issues discovered by Editoria11y. When you first install it, as there are no issues discovered yet, you need to browse the site to make this useful.

    If you visit the demo page at: /accessibility-tools-demo-page. Then revisit the dashboard, you should see that block gets populated with a list of some of the issues found. The header also changes to say "Recent issues", and there is a "more link" to a more detailed list page.

  • πŸ‡¬πŸ‡§United Kingdom the_g_bomb
  • πŸ‡¬πŸ‡§United Kingdom the_g_bomb

    I have updated the recipe. I suspect a different block may be a better choice for this on further investigation. I have also updated the recipe so that the dashboard now overrides the title to be more useful.

    I then updated the test to use the new title to identify if the block is being placed in the dashboard rather than testing if the config is being updated, as requested.

    I was struggling to identify the block as stark doesn't output the classes as expected in the test, but also I thought the title may be a bit brittle to use as a test, as it is being provided by a third-party module, and may change if the module updates at any point leading to a broken test, overriding the title means that should always be available.

  • πŸ‡¬πŸ‡§United Kingdom the_g_bomb
  • Pipeline finished with Failed
    20 days ago
    Total: 745s
    #537112
  • Pipeline finished with Failed
    20 days ago
    Total: 1406s
    #537122
  • πŸ‡ΊπŸ‡ΈUnited States phenaproxima Massachusetts

    I like that a lot better. I'd love to see Editoria11y merge some "no results found" text into their view, as I agree that the lack of any text at all is totally unclear. I wonder if there's a class we could add to the button which would allow it to become readable?

    It might be possible to do this stuff in the view without waiting on upstream, if we can figure out exactly which switches to pull in the dense jungle that is Views configuration.

  • πŸ‡¦πŸ‡ΊAustralia pameeela

    Not sure if it messes things up in the module but for our purposes, it would be better if the link was styled to match the block above, not as a button.

  • πŸ‡¦πŸ‡ΊAustralia pameeela

    Screenshot:

  • πŸ‡¦πŸ‡ΊAustralia pameeela

    Just looking at the view config. I don't think that a title override is the right behaviour for no results -- I think the title should stay the same, but with a message in the view explaining that either there are no issues or pages need to be viewed in order to show results.

    Also the button to view all should not appear if there are no results. Is this feedback better against the module rather than here? I don't think these are Drupal CMS overrides, IMO this should be the default behaviour.

  • πŸ‡¬πŸ‡§United Kingdom the_g_bomb

    Thanks Pamela. The title override for the no results is an issue with the module. I have opened a couple of issues already, and plan to open a couple more, so hopefully that specifically can be fixed.

    I have our own title override in place for the dashboard, so it shouldn't matter what happens to the view, if the module is updated, the title of this block will always remain as "Pages with accessibility alerts". I can change the text used there if required, but it also adds some stability for the recipe test that is in place.

    In terms of the button colour, I 100% agree that needs to be sorted. I'll look into where that is coming from. I thought the view was just using the standard More link, so it may be an issue with the Drupal CMS CSS, but I'll investigate and add changes here or in the module as appropriate.

  • πŸ‡¦πŸ‡ΊAustralia pameeela

    @the_g_bomb ahh sorry, I always forget about the 'More' link, I didn't even think about it being that. How strange that this link is getting button classes added but the other one isn't.

  • Pipeline finished with Failed
    19 days ago
    Total: 317s
    #538615
  • πŸ‡¬πŸ‡§United Kingdom the_g_bomb

    I have duplicated the reports block to override various bits as requested.
    e.g.: here is the new "No results message":

    And the listings with a link to the Editoria11y reports page.

  • πŸ‡¬πŸ‡§United Kingdom the_g_bomb
  • Pipeline finished with Failed
    19 days ago
    Total: 831s
    #538618
  • Pipeline finished with Failed
    15 days ago
    Total: 359s
    #541146
Production build 0.71.5 2024