issue_2501_addition_of_missing_safety_docs_templates#574
issue_2501_addition_of_missing_safety_docs_templates#574attifunel wants to merge 36 commits intoeclipse-score:mainfrom
Conversation
|
The created documentation from the pull request is available at: docu-html |
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.
Discussed this with @aschemmel-tech: possible conflicts with that other PR will be solved later. Agree?
process/folder_templates/platform/docs/verification/platform_verification_report.rst
Outdated
Show resolved
Hide resolved
process/folder_templates/platform/docs/verification/platform_verification_report.rst
Outdated
Show resolved
Hide resolved
process/folder_templates/platform/docs/safety_mgt/platform_safety_analysis_fdr.rst
Outdated
Show resolved
Hide resolved
process/folder_templates/platform/docs/safety_mgt/platform_safety_plan_fdr.rst
Outdated
Show resolved
Hide resolved
process/folder_templates/platform/docs/safety_mgt/platform_safety_plan_fdr.rst
Outdated
Show resolved
Hide resolved
process/folder_templates/platform/docs/safety_mgt/platform_safety_analysis_fdr.rst
Outdated
Show resolved
Hide resolved
| # 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
There was a problem hiding this comment.
Should be compliant with your requests now. Can you check?
process/folder_templates/platform/docs/verification/platform_verification_report.rst
Outdated
Show resolved
Hide resolved
| # 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?
process/folder_templates/platform/docs/verification/platform_verification_report.rst
Show resolved
Hide resolved
| # SPDX-License-Identifier: Apache-2.0 | ||
| # ******************************************************************************* | ||
|
|
||
| Safety Management |
There was a problem hiding this comment.
yes please (and delete the old folder "safety_planning")
process/folder_templates/platform/docs/safety_mgt/platform_safety_plan_fdr.rst
Show resolved
Hide resolved
process/folder_templates/platform/docs/safety_mgt/platform_safety_package_fdr.rst
Show resolved
Hide resolved
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)
Should I deleted the template in guidance then? |
process/folder_templates/platform/docs/safety_mgt/platform_safety_plan.rst
Show resolved
Hide resolved
|
@attifunel , you have still merge conflicts, please resolve them first |
I'm having issues in displaying them... they refer to a deleted file |
aschemmel-tech
left a comment
There was a problem hiding this comment.
see inline comments
process/folder_templates/modules/module_name/docs/verification/module_verification_report.rst
Show resolved
Hide resolved
| :realizes: wp__verification_platform_ver_report | ||
| :tags: template | ||
|
|
||
| **Place the document header here following the definitions in template |
There was a problem hiding this comment.
Please align with doc__module_name_verification_report : The header is already present above, missing is the ".. attention::" section (adapted to the platform document).
There was a problem hiding this comment.
Should be fixed now
process/folder_templates/modules/module_name/docs/release/release_note.rst
Outdated
Show resolved
Hide resolved
aschemmel-tech
left a comment
There was a problem hiding this comment.
Inline comments plus: stakeholder requirements document template still missing?
process/folder_templates/platform/docs/release/release_note.rst
Outdated
Show resolved
Hide resolved
process/folder_templates/platform/docs/release/release_note.rst
Outdated
Show resolved
Hide resolved
process/folder_templates/platform/docs/safety_mgt/platform_safety_manual.rst
Outdated
Show resolved
Hide resolved
process/folder_templates/platform/docs/safety_mgt/platform_safety_manual.rst
Outdated
Show resolved
Hide resolved
process/folder_templates/platform/docs/safety_mgt/platform_safety_manual.rst
Show resolved
Hide resolved
process/folder_templates/platform/docs/safety_mgt/platform_safety_manual.rst
Outdated
Show resolved
Hide resolved
process/folder_templates/platform/docs/safety_mgt/platform_safety_manual.rst
Outdated
Show resolved
Hide resolved
There's a host of templates already here https://eclipse-score.github.io/process_description/main/process_areas/requirements_engineering/guidance/requirements_templates.html |

As per #2501, missing safety specific documentation templates were added