This is a work-in-progress repository containing the Architecture Documentation of the Blue Brain Open Platform, as well as the review documents for the AWS Well-Architected Framework.
For convenience, the file format utilized for the documentation is Markdown, and for the diagrams is Scalable Vector Graphics (SVG) made with Draw.io. The plan would be to either publish a GitHub Page at some point, or to generate a proper documentation via other means.
One of the main reasons behind choosing the Markdown + Draw.io formats, is the convenience of having automatically available VSCode on GitHub for the very same repository. No installations nor complex configurations are required.
To edit any of the files, including the diagrams, you must simply access the following link to open VSCode:
The repository contains a .vscode folder with a recommendation to enable the Draw.io plugin for VSCode. Simply click on Install when prompted in the bottom-right of your screen, and from now on you will be able to edit any of the Draw.io figures inside GitHub.
Tip
You can also clone the repository locally and utilize your own installation of VSCode. The same plugins are available in both versions.
Warning
Please, use always SVG file format while working with new figures. Name the files as *.drawio.svg for the plugin to automatically detect the Draw.io files in VSCode.
The development of this was supported by funding to the Blue Brain Project, a research center of the École polytechnique fédérale de Lausanne (EPFL), from the Swiss government’s ETH Board of the Swiss Federal Institutes of Technology.
For license see LICENSE.txt.
Copyright (c) 2023-2024 Blue Brain Project/EPFL
