Simplify build of patterns and practices pages #2702
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
Milestone
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
Proposal for approach
The text was updated successfully, but these errors were encountered: