Anegm/per fmea json#2789
Conversation
|
|
masc2023
left a comment
There was a problem hiding this comment.
Needs discussion, put on agenda here https://github.com/orgs/eclipse-score/discussions/407#discussioncomment-16514494
|
The created documentation from the pull request is available at: docu-html |
2d504e1 to
c662c59
Compare
aschemmel-tech
left a comment
There was a problem hiding this comment.
What is the reasoning behind this? Work products shall be documented as sphinx needs elements. If you want a table view this can be done by a needtable.
Yeah that's true we can achieve the table presentation using needtable, but the intention is to make updating the FMEA more user friendly by enabling the team to use any xml editing tool like excel instead of dealing with RST formatting. |
So need to check, if this is still following this stakeholder requirement, https://eclipse-score.github.io/score/main/requirements/stakeholder/index.html#stkh_req__requirements__as_code |
I don't see why it wouldn't be following the stakeholder requirement a sphinx extension is still documented as (Docs-as-code). |
I am refering to the note: rationale: In this project no external tool or service is used. Therefore as-code is the selected option. |
I see what you mean, I'd argue that XML is just a data vehicle and you don't strictly need a specialized tool to edit it, also it's already in use in the project for tests reporting |
1- Use
needimportto import FMEA needs elements in the form of a json file.2- use
needtableto render the needs element in a table format for better readabilityBuild is failing pending patch to docs-as-code
eclipse-score/docs-as-code#516