Bug: stkh_req__archdes_example_req has no content

[MaximilianSoerenPollak]

Description

We introduce a new docs-as-code check in our effort to implement more tool requirements.

We now have implemented that Requirements of these types:

• Stakeholder requirement
• Feature requirement
• Component requirement
• Assumption of use requirement
• Process requirement
• Tool requirement

Need to have a non empty description (content).

Root cause:

In my local testing this error popped up:

process_areas/architecture_design/_assets/architecture_modeling_example.rst:209: WARNING: stkh_req__archdes_example_req: Need has no content. Content is mandatory for needs of type stkh_req [score_metamodel]

This check is marked as a 'new_check' so Errors regarding it won't fail the CI.
Though with the next module release of docs-as-code we want to enable this.

Impact:
No impact on safety/security, but quality issue

Analysis Results

Accepted

Solution

Provide example content for the stkh_req__archdes_example_req

Error Occurrence Rate

Reproducible

How to reproduce

Once this PR is merged:
eclipse-score/docs-as-code#152

Get new Docs-As-Code clone => Run docs-as-code bazel run //docs:incremental_release

Supporting Information

Any further questions let me know.

Classification

major

Affected Version

0.5

Expected Closure Version

0.5

Category

• Safety Related
• Security Related