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

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

Science Score: 13.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
  • DOI references
  • Academic publication links
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (12.8%) to scientific vocabulary
Last synced: 9 months ago · JSON representation

Repository

Basic Info
  • Host: GitHub
  • Owner: BlueBrain
  • License: apache-2.0
  • Default Branch: main
  • Size: 3.44 MB
Statistics
  • Stars: 2
  • Watchers: 2
  • Forks: 1
  • Open Issues: 0
  • Releases: 0
Archived
Created over 1 year ago · Last pushed over 1 year ago
Metadata Files
Readme License

README.md

[!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 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.

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

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.

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

Owner

  • Name: The Blue Brain Project
  • Login: BlueBrain
  • Kind: organization
  • Email: bbp.opensource@epfl.ch
  • Location: Geneva, Switzerland

Open Source Software produced and used by the Blue Brain Project

GitHub Events

Total
  • Watch event: 1
  • Delete event: 5
  • Member event: 1
  • Push event: 11
  • Public event: 1
  • Pull request review event: 3
  • Pull request event: 10
  • Fork event: 1
  • Create event: 5
Last Year
  • Watch event: 1
  • Delete event: 5
  • Member event: 1
  • Push event: 11
  • Public event: 1
  • Pull request review event: 3
  • Pull request event: 10
  • Fork event: 1
  • Create event: 5

Issues and Pull Requests

Last synced: over 1 year ago

All Time
  • Total issues: 0
  • Total pull requests: 5
  • Average time to close issues: N/A
  • Average time to close pull requests: 36 minutes
  • Total issue authors: 0
  • Total pull request authors: 4
  • Average comments per issue: 0
  • Average comments per pull request: 0.0
  • Merged pull requests: 5
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 5
  • Average time to close issues: N/A
  • Average time to close pull requests: 36 minutes
  • Issue authors: 0
  • Pull request authors: 4
  • Average comments per issue: 0
  • Average comments per pull request: 0.0
  • Merged pull requests: 5
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
Pull Request Authors
  • sergiorg-hpc (3)
  • heerener (2)
  • jdcourcol (2)
  • GianlucaFicarelli (2)
Top Labels
Issue Labels
Pull Request Labels