Update code-with-engineering-playbook/docs/design/design-reviews/recipes/preferred-diagram-tooling.md to recommend storage of raw and generated images for diagrams both #848
Is your feature request related to a problem? Please describe.
preferred-diagram-tooling.md doesn't recommend storage of image files. This can make PR reviews cumbersome if they don't render the diagrams referenced, and can prevent diagrams from being referenced in many places of the documentation.
Describe the solution you'd like
Generated diagrams should be saved to the repo.
Generally, we should offer advice that allows for tool-agnostic development.
It's ok to recommend .drawio, but we should also say that any tool that we use that generates diagrams (pngs, pdfs, jpgs, etc.) from code should commit both the generating code and the generated asset.
Describe alternatives you've considered
None.
Additional context
As per 6/9/22 Design Eng. Fundamentals meeting.
jakereifer
commented
2 years ago
Is your feature request related to a problem? Please describe. preferred-diagram-tooling.md doesn't recommend storage of image files. This can make PR reviews cumbersome if they don't render the diagrams referenced, and can prevent diagrams from being referenced in many places of the documentation.
Describe the solution you'd like Generated diagrams should be saved to the repo.
Generally, we should offer advice that allows for tool-agnostic development. It's ok to recommend .drawio, but we should also say that any tool that we use that generates diagrams (pngs, pdfs, jpgs, etc.) from code should commit both the generating code and the generated asset.
Describe alternatives you've considered None.
Additional context As per 6/9/22 Design Eng. Fundamentals meeting.