https://github.com/bluebrain/platform-docs

https://github.com/bluebrain/platform-docs

Last synced: 9 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/bluebrain/platform-docs
• Owner: BlueBrain
• License: apache-2.0
• Created: 2024-09-20T13:02:58.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-12-14T23:33:52.000Z (over 1 year ago)
• Last Synced: 2024-12-15T00:22:56.780Z (over 1 year ago)
• Size: 1.95 MB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

          
> [!WARNING]

> The Blue Brain Project concluded in December 2024, so development has ceased under the BlueBrain GitHub organization.

> Future development will take place at: https://github.com/openbraininstitute/platform-docs

# **Blue Brain Open Platform** - Documents

This is a work-in-progress repository containing the [Architecture Documentation](docs/) of the **Blue Brain Open Platform**, as well as the review documents for the [AWS Well-Architected Framework](waf).

For convenience, the file format utilized for the documentation is [Markdown](https://en.wikipedia.org/wiki/Markdown), and for the diagrams is Scalable Vector Graphics (SVG) made with [Draw.io](https://github.com/jgraph/drawio). The plan would be to either publish a GitHub Page at some point, or to generate a proper documentation via other means.

## How to Edit the Documentation and Diagrams

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:**

[![Edit repository with Visual Studio Code](.vscode/resources/edit_in_vscode.drawio.svg)](https://github.dev/BlueBrain/platform-docs)

The repository contains a `.vscode` folder with a recommendation to enable the [Draw.io plugin for VSCode](https://www.drawio.com/blog/edit-diagrams-with-github-dev). 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.

## Acknowledgements

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