Consider adding "Read This First link to the top of each pattern page"

[mcking65]

Consider adding "Read This First" to the top of each pattern page as proposed in a comment on issue #3274.

I know that you have a disclaimer on the Practices page. But not everyone checks the main page, especially when you have a link to a pattern and jump directly into it to save time. Based on working experience with many stakeholders (business/client managers, product owners, designers, developers) I am sure it could benefit to have a disclaimer/reference to https://www.w3.org/WAI/ARIA/apg/practices/read-me-first/ at the top of each pattern :-)

Originally posted by @asedymova in #3274

[css-meeting-bot]

The ARIA Authoring Practices (APG) Task Force just discussed Issue 3293 - Add read this first to pattern pages?.

The full IRC log of that discussion

<jugglinmike> topic: Issue 3293 - Add read this first to pattern pages?
<jugglinmike> github: https://github.com/w3c/aria-practices/issues/3293
<jugglinmike> Matt_King: This was a request for a change to the APG, sort of an editorial change
<jugglinmike> Matt_King: It originated as a side-comment on another issue (there is a link included)
<jongund> I have to leave a little early
<jugglinmike> Matt_King: We have a prominent link to the "read this first" content at the top of the index pages, but not on the individual pattern pages
<jugglinmike> Matt_King: It was suggested that we may want to do that
<jugglinmike> Matt_King: I wish we had Isaac...
<jugglinmike> Matt_King: I don't know, from the structure of the pages, how reusable the design is for the disclosure which has the "read this first" link. Do people think this is a good idea? Should we put it at the top of every pattern? If so, where? Right after the "h1" heading?
<jugglinmike> howard-e: Yeah, I think it would fit stylistically. I don't see why not
<jugglinmike> howard-e: I'm not opposed to this idea
<jugglinmike> Matt_King: It is pretty short--it's just a heading and one line. It doesn't seem like it would really get in the way much
<jugglinmike> howard-e: On the "patterns" page, these is a graphic which may not be necessary on each "pattern" page
<jugglinmike> howard-e: The graphic feels more in place on the index page because of all the cards
<jugglinmike> lola: I think I agree with howard-e
<jugglinmike> Matt_King: I know that the "read this first" section is pulled in with an "include" directive or something... We'd want to do it in the same way. I think it would mean modifying all twenty-something "pattern" pages.
<jugglinmike> howard-e: Yes, I think so. Maybe also a small modification to the "read this first". I don't think there is anything that would have to happen in the "builder" repository
<jugglinmike> Matt_King: I would like to avoid any changes to the "builder" repository unless it was necessary
<jugglinmike> lola: The section we're talking about is just the "no ARIA is better than bad ARIA" bit, right?
<jugglinmike> Matt_King: We would include the link
<jugglinmike> Matt_King: Okay, I'm going to assign this to you, howard-e
<jugglinmike> Zakim, end the meetng
<Zakim> I don't understand 'end the meetng', jugglinmike
<jugglinmike> Zakim, end the meeting

[css-meeting-bot]

The ARIA Authoring Practices (APG) Task Force just discussed Issue 3293: Adding "Read This First" link to the top of each pattern page.

The full IRC log of that discussion

<jugglinmike> Topic: Issue 3293: Adding "Read This First" link to the top of each pattern page
<jugglinmike> github: https://github.com/w3c/aria-practices/issues/3293
<jugglinmike> Matt_King: howard-e, you're working on this issue
<jugglinmike> howard-e: There's a pull request for this
<jugglinmike> Matt_King: The part of this that became confusing to me is that it seems like we have some of the content being controlled from the build repository
<jugglinmike> Matt_King: When I review "practices.html" and "patterns.html", at least in the screen reader reading order, the very first thing after the "h1" is the "read this first section"
<jugglinmike> Matt_King: ...but there isn't anything there on those pages related to "read this first" content
<jugglinmike> Matt_King: So if I preview those pages that have "read this first" from the content repository--if I preview them locally, that content doesn't show up. "read this first" isn't there
<jugglinmike> howard-e: yes, that surprised me as well.
<jugglinmike> howard-e: The "read this first" banner has always been getting injected
<jugglinmike> howard-e: I'm wondering whether or not we should move that over to the "content" repository entirely
<jugglinmike> Matt_King: I think that's a good thing--especially if we're ever to move to another build system--to make sure the content is fully controlled from the content repository
<jugglinmike> howard-e: Got it. I can re-purpose this PR with that in mind
<jugglinmike> Matt_King: So it will be a little longer before this is ready for review by other people
<jugglinmike> howard-e: I think I should be able to have this ready by the next meeting
<jugglinmike> Matt_King: Awesome, then we'll keep it on the agenda for next week