diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS index 5c36fee..f066ddd 100644 --- a/.github/CODEOWNERS +++ b/.github/CODEOWNERS @@ -19,10 +19,10 @@ # in separate repositories: # # /docs @eclipse-score/process-community -# /docs/manual @eclipse-score//safety-manager +# /docs/manuals @eclipse-score//safety-manager # /docs/release @eclipse-score//quality-manager @eclipse-score//module-lead # /docs/safety_plan @eclipse-score//safety-manager @eclipse-score//module-lead # /docs/safety_analysis @eclipse-score//safety-manager -# /docs/verification @eclipse-score//quality-manager @eclipse-score//safety-manager +# /docs/verification_report @eclipse-score//quality-manager @eclipse-score//safety-manager # /components @eclipse-score//technical-lead # /components/*/ @eclipse-score//automotive-score-committers diff --git a/docs/manual/index.rst b/docs/manuals/index.rst similarity index 100% rename from docs/manual/index.rst rename to docs/manuals/index.rst diff --git a/docs/manual/safety_manual.rst b/docs/manuals/safety_manual.rst similarity index 100% rename from docs/manual/safety_manual.rst rename to docs/manuals/safety_manual.rst diff --git a/docs/manual/security_manual.rst b/docs/manuals/security_manual.rst similarity index 100% rename from docs/manual/security_manual.rst rename to docs/manuals/security_manual.rst diff --git a/docs/verification/module_verification_report.rst b/docs/verification_report/module_verification_report.rst similarity index 100% rename from docs/verification/module_verification_report.rst rename to docs/verification_report/module_verification_report.rst diff --git a/index.rst b/index.rst index 7a677ff..b25d871 100644 --- a/index.rst +++ b/index.rst @@ -95,11 +95,11 @@ Module / Feature Documentation :maxdepth: 1 docs/features/index - docs/manual/index + docs/manuals/index docs/release/release_note docs/safety_mgt/index docs/security_mgt/index - docs/verification/module_verification_report + docs/verification_report/module_verification_report Component documentation ------------------------------- diff --git a/score/component_example/docs/architecture/index.rst b/score/component_example/docs/architecture/index.rst index 15ef076..a18b1bf 100644 --- a/score/component_example/docs/architecture/index.rst +++ b/score/component_example/docs/architecture/index.rst @@ -70,7 +70,7 @@ Static Architecture The components are designed to cover the expectations from the feature architecture (i.e. if already exists a definition it should be taken over and enriched). -A component can optional also consist of subcomponents to further structure the architecture. The component and its static views can also optionally use interfaces provided by other components. +A component can optional also consist of lower level components to further structure the architecture. The component and its static views can also optionally use interfaces provided by other components. .. comp:: Component Name :id: comp__mod_temp_component_name_template @@ -78,7 +78,7 @@ A component can optional also consist of subcomponents to further structure the :safety: ASIL_B :status: invalid :consists_of: comp__mod_temp_archex_sub_component_1, comp__mod_temp_archex_sub_component_2, comp__mod_temp_archex_sub_component_3 - :belongs_to: feat__feature_name + :belongs_to: feat__mtef .. comp_arc_sta:: Component Name (Static View) :id: comp_arc_sta__mod_temp_component_name__sv diff --git a/score/component_example/docs/detailed_design/detailed_design_example.rst b/score/component_example/docs/detailed_design/detailed_design_example.rst index 5452893..be22ecb 100644 --- a/score/component_example/docs/detailed_design/detailed_design_example.rst +++ b/score/component_example/docs/detailed_design/detailed_design_example.rst @@ -32,7 +32,6 @@ Static Diagrams for Unit Interactions :status: valid :implements: comp_req__example_feature__example_req :satisfies: comp_arc_sta__example_feature__comp_1 - :includes: sw_unit__example_feature__unit1, sw_unit__example_feature__unit2 .. uml:: dd_example_ex_sta.puml diff --git a/score/component_example/docs/requirements/index.rst b/score/component_example/docs/requirements/index.rst index debd3e5..56d115a 100644 --- a/score/component_example/docs/requirements/index.rst +++ b/score/component_example/docs/requirements/index.rst @@ -42,7 +42,7 @@ Component Requirements :reqtype: Process :security: YES :safety: ASIL_B - :satisfies: feat_req__feature_name__some_title + :satisfies: feat_req__example_feature__example_req :status: invalid :belongs_to: comp__mod_temp_component_name_template