-
Notifications
You must be signed in to change notification settings - Fork 19
fix issues which prevent latest main update #349
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
fix issues which prevent latest main update #349
Conversation
License Check Results🚀 The license check job ran with the Bazel command: bazel run //src:license-checkStatus: Click to expand output |
|
The created documentation from the pull request is available at: docu-html |
| gd_req__impl_design_code_link, | ||
|
|
||
| Docs-as-Code shall allow source code to link to needs. | ||
| Docs-as-Code shall allow source code to link to requirement needs. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It can be any need though, right? Tests, requirements, documents etc.
So I guess maybe better to say Sphinx-Needs ?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
No, at this place (from the upper layer linked requirement gd_req__req_attr_impl) only requirements need to be linked.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Add sphinx needs to text before requirement mentioned
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would keep it as is to be honest. We intentionally said "needs" here, as our tool supports more than the process requires.
MaximilianSoerenPollak
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just two quick comments.
Though they can also be fixed in future PR.
Update documentation to specify 'sphinx-needs' for linked requirements. Signed-off-by: RolandJentschETAS <[email protected]>
31fb7a0
Removed commented-out req-Id section from metamodel.yaml. Signed-off-by: RolandJentschETAS <[email protected]>
Signed-off-by: RolandJentschETAS <[email protected]>
| .. :satisfies: gd_req__impl_dynamic_diagram | ||
| Provide needs type ``dd_dyn`` for dynamic diagrams showing unit interactions as UML. | ||
| .. Provide needs type ``dd_dyn`` for dynamic diagrams showing unit interactions as UML. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Commenting is not a good idea. Delete it.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
See below
| parts: 3 | ||
|
|
||
| # req-Id: tool_req__docs_dd_dyn | ||
| dd_dyn: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If there is no requirement for the dd_dyn element, shouldn't we delete it from the metamodel?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The problem is, that the process description of the implementation process still contains a dynamic diagram, but the process requirement is gone. So it is currently unclear if deletion of the requirement was a mistake or not. The PR is only to make overall update is running. But it don't solve the issue, that the implementation process contains undefined parts. But this is in another repo and must be fixed after discussion.
AlexanderLanin
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Open points remain relevant; and please do address them!
However they can equally well be addressed post merge, so I'm merging this now.
| gd_req__impl_design_code_link, | ||
|
|
||
| Docs-as-Code shall allow source code to link to needs. | ||
| Docs-as-Code shall allow source code to link to requirement sphinx-needs objects. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would keep this as it was, since our tool requirement intentionally did not differentiate whether its a requirement or not. The tool was more generic, then the minimum process requirement.
📌 Description
fix issues which prevent latest main update.
Otherwise integration fails (bazel run //:docs_combo_experimental does not run)
🚨 Impact Analysis
✅ Checklist