Content Structure for Reference Architectures
The content structure has been defined and is identical for all reference architectures.
Example
Here is an example of the content structure for a reference architecture:
ref-arch/
├─ RAXXXX/
│ ├─ 1-first-subfolder/
│ │ ├─ drawio/
│ │ │ ├─ solution-diagram-1.drawio
│ │ ├─ images/
│ │ │ ├─ image-1.png
│ │ ├─ readme.md
│ ├─ 2-second-subfolder/
│ │ ├─ drawio/
│ │ │ ├─ solution-diagram-2.drawio
│ │ ├─ images/
│ │ │ ├─ image-2.jpg
│ │ ├─ readme.md
│ ├─ drawio/
│ │ ├─ solution-diagram-1.drawio
│ ├─ images/
│ ├─ readme.md
Example explained
The same example with some explanations:
ref-arch/
├─ RAXXXX/ <------------------------------ Your RA folder
│ ├─ 1-first-subfolder/ <---------------- First subfolder/subpage for your RA
│ │ ├─ drawio/ <------------------------ Drawio folder for your solution diagram
│ │ │ ├─ solution-diagram-1.drawio <--- Your solution diagram in drawio format
│ │ ├─ images/ <------------------------ Images folder
│ │ │ ├─ image-1.png <----------------- Your image
│ │ ├─ readme.md <---------------------- First subpage of your RA
│ ├─ 2-second-subfolder/ <--------------- Second subfolder/subpage for your RA
│ │ ├─ drawio/ <------------------------ Drawio folder for your solution diagram
│ │ │ ├─ solution-diagram-2.drawio <--- Your solution diagram in drawio format
│ │ ├─ images/ <------------------------ Images folder
│ │ │ ├─ image-2.jpg <----------------- Your image
│ │ ├─ readme.md <---------------------- Second subpage of your RA
│ ├─ drawio/ <--------------------------- Drawio folder for your solution diagram
│ │ ├─ solution-diagram-1.drawio <------ Your solution diagram in drawio format
│ ├─ images/ <--------------------------- Images folder
│ ├─ readme.md <------------------------- This is the main page of your RA
Note
The .svg version of each solution diagram is generated automatically from its .drawio file and placed in the sibling images/ folder.