You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
We need to create an ARCHITECTURE.md that covers the overall system.
This document could, if necessary, reference architecture documents found in each components repository. These would essentially document just themselves. The intent is to define once and reference as many times as needed.
For example, the ARCHITECTURE.md created in this repository may say something like:
Be stored along with their corresponding "source" files (for example, if a .png file is referenced, the .svg file that was used to generate the .png must also be stored to allow the diagrams to be updated by all.
Use freely available open formats for their sources.
The text was updated successfully, but these errors were encountered:
We need to create an
ARCHITECTURE.md
that covers the overall system.This document could, if necessary, reference architecture documents found in each components repository. These would essentially document just themselves. The intent is to define once and reference as many times as needed.
For example, the
ARCHITECTURE.md
created in this repository may say something like:Component repositories
The individual
README.md
files in each code repository must contain a reference to this central architecture document.If a component repository has a separate
ARCHITECTURE.md
this:README.md
.ARCHITECTURE.md
document.For an example of what we should be aiming for, see the Clear Containers architecture document:
Diagrams
All diagrams must:
.png
file is referenced, the.svg
file that was used to generate the.png
must also be stored to allow the diagrams to be updated by all.The text was updated successfully, but these errors were encountered: