Skip to content

Anegm/per fmea json#2789

Open
ANegm-ETAS wants to merge 8 commits intoeclipse-score:mainfrom
etas-contrib:anegm/per-fmea-xml
Open

Anegm/per fmea json#2789
ANegm-ETAS wants to merge 8 commits intoeclipse-score:mainfrom
etas-contrib:anegm/per-fmea-xml

Conversation

@ANegm-ETAS
Copy link
Copy Markdown
Contributor

@ANegm-ETAS ANegm-ETAS commented Apr 14, 2026

1- Use needimport to import FMEA needs elements in the form of a json file.
2- use needtable to render the needs element in a table format for better readability

Build is failing pending patch to docs-as-code
eclipse-score/docs-as-code#516

@github-actions
Copy link
Copy Markdown

⚠️ Docs-as-Code version mismatch detected
Please check the CI build logs for details and align the documentation version with the Bazel dependency.

Copy link
Copy Markdown
Contributor

@masc2023 masc2023 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@github-actions
Copy link
Copy Markdown

The created documentation from the pull request is available at: docu-html

Copy link
Copy Markdown
Contributor

@aschemmel-tech aschemmel-tech left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@ANegm-ETAS
Copy link
Copy Markdown
Contributor Author

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.

@masc2023
Copy link
Copy Markdown
Contributor

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

@ANegm-ETAS
Copy link
Copy Markdown
Contributor Author

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).

@masc2023
Copy link
Copy Markdown
Contributor

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.
Xml for me would not be really doc as code, especially if I need an editor or excel

@ANegm-ETAS
Copy link
Copy Markdown
Contributor Author

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. Xml for me would not be really doc as code, especially if I need an editor or excel

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

@ANegm-ETAS ANegm-ETAS changed the title Anegm/per fmea xml Anegm/per fmea json Apr 29, 2026
@ANegm-ETAS ANegm-ETAS marked this pull request as ready for review April 30, 2026 08:25
@ANegm-ETAS ANegm-ETAS requested a review from PandaeDo as a code owner April 30, 2026 08:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Backlog

Development

Successfully merging this pull request may close these issues.

4 participants