Skip to content

Commit f699c8a

Browse files
authored
Add doxygen shield and links (#175)
1 parent 0be3ced commit f699c8a

2 files changed

Lines changed: 9 additions & 1 deletion

File tree

README.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,14 @@
11
<!-- \cond EXCLUDE_FOR_DOXYGEN -->
22
[![aliBuild](https://img.shields.io/badge/aliBuild-dashboard-lightgrey.svg)](https://alisw.cern.ch/dashboard/d/000000001/main-dashboard?orgId=1&var-storagename=All&var-reponame=All&var-checkname=build%2FQualityControl%2Fo2-dataflow%2F0&var-upthreshold=30m&var-minuptime=30)
33
[![JIRA](https://img.shields.io/badge/JIRA-Report%20issue-blue.svg)](https://alice.its.cern.ch/jira/secure/CreateIssue.jspa?pid=11201&issuetype=1)
4+
[![doxygen](https://img.shields.io/badge/doxygen-documentation-blue.svg)](https://aliceo2group.github.io/QualityControl/)
5+
[![Discourse](https://img.shields.io/badge/discourse-Get%20help-blue.svg)](https://alice-talk.web.cern.ch/)
6+
47
<!-- \endcond -->
58

69
This is the repository of the data quality control (QC) software for the ALICE O<sup>2</sup> system.
710

8-
For a general overview of our software, organization and processes, please see this [page](https://aliceo2group.github.io/).
11+
For a general overview of our (O2) software, organization and processes, please see this [page](https://aliceo2group.github.io/).
912

1013
<!--TOC generated with https://github.com/ekalinin/github-markdown-toc-->
1114
<!--./gh-md-toc --insert /path/to/README.md-->

doc/DevelopersTips.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,11 @@
33
This is a resource meant for the developers of the QC. Whenever we learn something useful we put it
44
here. It is not sanitized or organized. Just a brain dump.
55

6+
### Doxygen generation
7+
8+
To generate locally the doxygen doc, do `cd sw/BUILD/QualityControl-latest/QualityControl; make doc`.
9+
It will be available in doc/html, thus to open it quickly do `[xdg-]open doc/html/index.html`.
10+
611
### Monitoring debug
712

813
When we don't see the monitoring data in grafana, here is what to do to pinpoint the source of the problem.

0 commit comments

Comments
 (0)