issue_2501_addition_of_missing_safety_docs_templates#574
issue_2501_addition_of_missing_safety_docs_templates#574attifunel wants to merge 12 commits intoeclipse-score:mainfrom
Conversation
attifunel
requested review from
PandaeDo,
aschemmel-tech,
masc2023 and
pahmann
as code owners
|
The created documentation from the pull request is available at: docu-html |
attifunel
changed the title
attifunel
changed the title
pahmann
force-pushed
the
attifunel_missing_safety_docs_templates
branch
from
26e74d8 to
7a74e1b
Compare
Correct one duplicated entry as copy-paste issue for safety_analysis_fdr Signed-off-by: Philipp Ahmann <Philipp.Ahmann@de.bosch.com>
| # SPDX-License-Identifier: Apache-2.0 | ||
| # ******************************************************************************* | ||
|
|
||
| Verification Report |
There was a problem hiding this comment.
Sunil is back on Monday, I've planned an alignment
| # SPDX-License-Identifier: Apache-2.0 | ||
| # ******************************************************************************* | ||
|
|
||
| Verification Report |
There was a problem hiding this comment.
Platform Verification Report
|
|
||
| .. note:: Document header | ||
|
|
||
| .. document:: platform Verification Report |
| # ******************************************************************************* | ||
|
|
||
|
|
||
| Safety Analysis Checklist |
| # SPDX-License-Identifier: Apache-2.0 | ||
| # ******************************************************************************* | ||
|
|
||
| Safety Plan Formal Review Report |
|
|
||
| .. note:: Document header | ||
|
|
||
| .. document:: PlatformSafety Plan Formal Review |
There was a problem hiding this comment.
Space missing after Platform
| # ******************************************************************************* | ||
|
|
||
|
|
||
| Safety Analysis Checklist |
There was a problem hiding this comment.
Platform Safety Analysis Formal Review Report
| # SPDX-License-Identifier: Apache-2.0 | ||
| # ******************************************************************************* | ||
| Safety Management |
There was a problem hiding this comment.
if you introduce here a new folder, why not move also Safety Planning here Platform DFA, etc. align with Security, that we can have there also a subfolder, Verification Report can stay on top level as well Stakeholder Requirements
There was a problem hiding this comment.
I aligned with Module Directories
There was a problem hiding this comment.
Can you please move the safety Plan template also in this folder?
There was a problem hiding this comment.
yes please (and delete the old folder "safety_planning")
There was a problem hiding this comment.
hmhmhm... Platform safety plan template was embedded in the "index.rst" of the specific directory, something I needed some time to sort out. I removed directory there and created a new file here with the right name
| # SPDX-License-Identifier: Apache-2.0 | ||
| # ******************************************************************************* | ||
|
|
||
| Verification Report |
There was a problem hiding this comment.
Platform Verification Report
| # SPDX-License-Identifier: Apache-2.0 | ||
| # ******************************************************************************* | ||
| Safety Management |
There was a problem hiding this comment.
Can you please move the safety Plan template also in this folder?
There was a problem hiding this comment.
Please add here an index as for Safety_Mgt, otherwise it ins not in a subfolder and nove here also Safety Analysis Checklist
There was a problem hiding this comment.
should also be in the "docs" folder like the others
There was a problem hiding this comment.
should also be in the "docs" folder like the others
| # SPDX-License-Identifier: Apache-2.0 | ||
| # ******************************************************************************* | ||
|
|
||
| Platform Verification Report |
There was a problem hiding this comment.
Why did you have a new template content and not took over what is already in https://eclipse-score.github.io/process_description//main/process_areas/verification/guidance/verification_report_template.html#gd_temp__platform_ver_report ? - and only have a reference there that points to this template
There was a problem hiding this comment.
Because I missed it (it's not in the template folder I was searching in). I will fix this
There was a problem hiding this comment.
when you say "there" and "here" what do you mean exactly? Just to be sure before mkaing changes that I have to revert.
| # SPDX-License-Identifier: Apache-2.0 | ||
| # ******************************************************************************* | ||
| Safety Management |
There was a problem hiding this comment.
yes please (and delete the old folder "safety_planning")
| **1. Purpose** | ||
|
|
||
| The purpose of this safety plan formal review checklist is to report status of the review for the platform safety plan. | ||
|
|
There was a problem hiding this comment.
Please add "Conduct" section as in https://eclipse-score.github.io/process_description/main/folder_templates/modules/module_name/docs/safety_mgt/module_safety_plan_fdr.html
| **1. Purpose** | ||
|
|
||
| The purpose of this review checklist is to report status of the formal review for the platform safety package. | ||
|
|
There was a problem hiding this comment.
Please add "Conduct" section as in https://eclipse-score.github.io/process_description/main/folder_templates/modules/module_name/docs/safety_mgt/module_safety_package_fdr.html
aschemmel-tech
left a comment
aschemmel-tech
left a comment
There was a problem hiding this comment.
See inline comments and:
- add release/release_note.rst (platform release note template from release/guidance)
- add manual/safety_manual.rst (from https://eclipse-score.github.io/process_description/main/folder_templates/modules/module_name/docs/manual/safety_manual.html)
- add requirements/index.rst (create stakeholder requirements document template, similar to the one for feature requirements)
4 participants
As per #2501, missing safety specific documentation templates were added