search

w3c / wai-aria-practices

WAI Website Resource for aria-practices guidelines
https://aria-practices.netlify.app/aria/apg/
15 stars 14 forks source link

Can this be used to do live local development of patterns? #256

Open ZoeBijl opened 10 months ago

ZoeBijl commented 10 months ago

Currently migrating this tooltip pattern to satisfy https://github.com/w3c/aria-practices/issues/127. I’d like to view my edits in my local copy of this website if possible; is there a way to do this?

Simply running the jekyll serve doesn’t seem to do this?

mcking65 commented 9 months ago

AFAIK, no. Not saying impossible but rather that it is not something we intended anyone to do.

All content originates in aria-practices. Github actions generate previews for any branch or fork. So, you can test the main content of the page locally. Then, when you want to see that content with the web site chrome, you can create a PR and use the netlify preview.

ZoeBijl commented 9 months ago

This sounds like a lot of extra steps to verify that the WAI website CSS/JS isn’t interfering with the pattern example code.

Is this procedure documented anywhere?

mcking65 commented 9 months ago

@ZoeBijl wrote:

This sounds like a lot of extra steps to verify that the WAI website CSS/JS isn’t interfering with the pattern example code.

It is one step, create a PR, which will generate a preview. Admittedly, that is not a small step, especially for a new contributor who may want to make such checks before pushing their work into a public space. From that perspective, it is not yet an ideal solution.

On the other hand, a procedure that enables complete offline preview is likely going to be more technically complex. As long as we still have the two-repo architecture, it would probably involve more steps.

For now, we are not investigating consolidation of the content and build repos. We don't have anyone to do that work at this time. In addition, some of the work might have to be re-done in 2024 because WAI is planning to redesign the back-end of the entire WAI site.

Is this procedure documented anywhere?

Not as well as it should be. This has come up in recent discussions of w3c/aria-practices#2734. We have identified a need to make significant changes to the readme to help new contributors.

a11ydoer commented 9 months ago

@ZoeBijl I also created the issue 2781, "Transfer APG deployment process to Github Wiki page" and assigned it to me. I plan to work on this issue within two weeks timeframe.

The orginal issue 13 in Wai aria practice repo, explains overall processes for PR and Deployement, which will be helpful for further understanding.