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

Simplify build of patterns and practices pages #2702

Closed
mcking65 opened this issue May 16, 2023 · 3 comments
Closed

Simplify build of patterns and practices pages #2702

mcking65 opened this issue May 16, 2023 · 3 comments
Assignees
Labels
enhancement Any addition or improvement that doesn't fix a code bug or prose inaccuracy Infrastructure Related to maintaining task force and repo operations, processes, systems, documentation

Comments

@mcking65
Copy link
Contributor

mcking65 commented May 16, 2023

The problem

Currently the patterns and practices pages are built by scripts that process the content of all the individual pattern and practice pages. This auto-generation adds complexity and constrains editorial control.

The complexity of auto-generation sometimes leads to build failures, such as the failure mentioned in this comment by James on PR 2670.

Because the patterns and practices pages are built by scripts, editors can't control some important aspects of the content. They can't manipulate the order in which practices are presented. They also have limited control of the abstract that describes each pattern and practice on the patterns and practices pages. The abstract is pulled from the first sentences of the about section of a pattern or practice. Generally, this works well, but there are times when the abstract could be improved by highlighting information that that can't be easily crammed into the first sentence without degrading readability.

The patterns and practices pages do not need to be updated frequently. So, the effort and time saved by auto-generation is fairly small.

Simplifying the build process will improve the long term sustainability of the APG by reducing the need for engineering support.

Solution Proposal

  1. Source patterns page content from content/patterns/patterns.html
  2. Source practices page content from content/practices/practices.html
  3. Make the build of home, patterns, practices, and about as simple and consistent as is reasonable.
  4. Document a clear set of classes and DOM structure requirements that editors can use when building and revising content for those pages.

Proposal for approach

  • Start small and iterate
  • Draft a PR that moves the practices page content into practices.html. This should also ensure that all images used on the practices page are sourced from content/images.
  • After practices build is working well, repeat with another PR for the patterns page.
  • Look for opportunities to simplify by better aligning the way home, patterns, practices, and about are coded and processed.
@mcking65 mcking65 added enhancement Any addition or improvement that doesn't fix a code bug or prose inaccuracy Infrastructure Related to maintaining task force and repo operations, processes, systems, documentation labels May 16, 2023
@ccanash
Copy link

ccanash commented May 16, 2023

We will triage this task this week.

@ccanash
Copy link

ccanash commented Jun 6, 2023

Hi @mcking65 , we triage this and the next step is clear for us but we won't work on this until we reprioratize APG work

@ccanash
Copy link

ccanash commented Dec 20, 2023

Closing as this was deployed to prod on dec 12 w3c/wai-aria-practices#280

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Any addition or improvement that doesn't fix a code bug or prose inaccuracy Infrastructure Related to maintaining task force and repo operations, processes, systems, documentation
Projects
None yet
Development

No branches or pull requests

4 participants