Documentation - Reusing Content

We try to provide as much as possible reusable artefacts, e.g. for plots and data.

About plots

Almost all charts are saved with known file names, which makes them persistent and easy to reuse in external resources. In most cases, one can simply reuse the image URL as the source for the image they want to display.

As an example, to reuse the commits activity chart for the Eclipse Chariott in markdown, use the following markdown text:

![Eclipse Chariott commits](https://metrics.eclipse.org/images/projects/commits_automotive.chariott.png)

Which produces the following image:

CSV files

We also provide CSV files for commits and issues, which can be downloaded from the project or working group pages. They can be easily imported in any BI tool (e.g. spreadsheets, or dedicated data visualisation products) or in any programming language (e.g. Python and Pandas dataframes).

$ python
Python 3.11.7 (main, Dec  4 2023, 18:10:11) [Clang 15.0.0 (clang-1500.1.0.2.5)] on darwin
Type "help", "copyright", "credits" or "license" for more information.
>>> import pandas as pd
>>> commits_kuksa = pd.read_csv("automotive.kuksa_commits.csv")
>>> commits_kuksa.head()
   Unnamed: 0                                 hash_long hash_short  ... files           created_at                                         repo_name
0        1274  661b203a153e5298e93fd1cc927e16c8dbcade6d     661b20  ...     4  2023-02-09 12:39:30          https://github.com/eclipse/kuksa.val.git
1        1275  3c8dbb148d67bd81d0ca13cf8edfbe311b57a270     3c8dbb  ...     4  2023-02-09 12:39:30          https://github.com/eclipse/kuksa.val.git
2        1409  b01698fa045dc3749d03f06e59859c0f869dfd17     b01698  ...     4  2023-02-09 15:13:29  https://github.com/eclipse/kuksa.val.feeders.git
3        1422  bfc9caa3feb692cecbff84c418fe9a0aba837269     bfc9ca  ...     1  2023-02-09 15:29:16  https://github.com/eclipse/kuksa.val.feeders.git
4        1528  e87603ded36e0449195862bd3a692362f7856264     e87603  ...     1  2023-02-09 17:50:02  https://github.com/eclipse/kuksa.val.feeders.git

[5 rows x 15 columns]

SDV Badges

SDV badges are meant to be reused in other places, for example on the README of an Eclise project. They are built using the following schema:

https://metrics.eclipse.org/badges/<project_id>_badge_<badge_type>.png

Where

• project_id is the ID of the project, e.g. automotive.ankaios
• badge_type is a maturity assessment criterion, one of documentation, coding_guidelines, test_traceability, requirements_traceability, or integration.

The following code:

![Documentation badge for automotive.ankaios](https://metrics.eclipse.org/badges/automotive.ankaios_badge_documentation.png "Documentation badge for automotive.ankaios")

Produces the following image: