Each metric should be described in a single document
Feature Motivation
Having all the metrics described in a single file makes hard to read them and if the list grows, it would make hard the document to be maintained.
Ideally, the list should be part of Cauldron site itself, and not something written in a .md file in this GitLab repo.
Issue Relation
This feature request is related somehow with issue #418 (closed).
Possible Implementations
Each new metric implemented in Cauldron project dashboard should be designed to comply with the following rules:
- It's part of a section (overview, activity, community, etc.)
- There is a link to a .md file that describes it, or to a page in cauldron.io that describes it
Layout Idea
I think we could start for having a better information architecture. Something like a folder with following structure:
classDiagram
Metrics <|-- Overview
Metrics <|-- Community
Metrics <|-- Activity
Metrics <|-- Process
Overview <|-- Metric overview 1
Overview <|-- Metric overview 2
Overview <|-- Metric overview n
Community <|-- Metric community 1
Community <|-- Metric community 2
Community <|-- Metric community n
Activity <|-- Metric activity 1
Activity <|-- Metric activity 2
Activity <|-- Metric activity n
Process <|-- Metric process 1
Process <|-- Metric process 2
Process <|-- Metric process n