eclipse-score / eclipse-score/process_description

Request: documents should link what they document

Open
#784 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
HTML
Stars
4
Forks
22
Avg merge
9h 40m
Merged PRs (30d)
12

Description

My concrete example is the [module verification report](https://eclipse-score.github.io/module_template/main/verification_report/module_verification_report.html)

Currently the analyzed module can be determined from the id only, or from being in the same repository. While that is theoretically enough for traceability, a more explicit link would help traceability tooling.

Proposal: extend [document](https://eclipse-score.github.io/docs-as-code/main/reference/metamodel/index.html#document) with a `documents` or `affects` or `belongs_to` links or similar, which would link to the `mod` in question.

This will also establish a backlink from modules to module verification reports.

---

Todays workaround is a custom type which has such a link. This allows automated generation of such reports.

Image

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.