Skip to content
Snippets Groups Projects
Normal view Permalink
README.md 402 B
Newer Older
Bjarke Madsen's avatar
Update readme and add example config  
Bjarke Madsen committed
1 
# BRIAN Dashboard Manager
Bjarke Madsen's avatar
Add initial code for handling organizations.
Bjarke Madsen committed
2
Erik Reid's avatar
spread out docs  
Erik Reid committed
3 4 
The BRIAN Dashboard Manager is used
provision Organizations and Dashboards in Grafana for BRIAN.
Bjarke Madsen's avatar
Add initial code for handling organizations.
Bjarke Madsen committed
5
Erik Reid's avatar
spread out docs  
Erik Reid committed
6 
Documentation can be generated by running sphinx:
Bjarke Madsen's avatar
Add initial code for handling organizations.
Bjarke Madsen committed
7 8 

```bash
Erik Reid's avatar
spread out docs  
Erik Reid committed
9 
sphinx-build -M html docs/source docs/build
Bjarke Madsen's avatar
Add initial code for handling organizations.
Bjarke Madsen committed
10 11 
```
Erik Reid's avatar
spread out docs  
Erik Reid committed
12 13 
The documents should be viewable in the
workspace of the most recent [Jenkins job](https://jenkins.geant.org/job/brian-dashboard-manager/ws/docs/build/html/index.html).