diff --git a/MODULE.bazel b/MODULE.bazel index 5d00063..576b857 100644 --- a/MODULE.bazel +++ b/MODULE.bazel @@ -75,7 +75,7 @@ bazel_dep(name = "aspect_rules_lint", version = "1.10.2", dev_dependency = True) bazel_dep(name = "buildifier_prebuilt", version = "8.5.1.2", dev_dependency = True) #docs-as-code -bazel_dep(name = "score_docs_as_code", version = "4.0.3", dev_dependency = True) +bazel_dep(name = "score_docs_as_code", version = "4.2.0", dev_dependency = True) bazel_dep(name = "score_process", version = "1.5.4", dev_dependency = True) # grpc-java 1.66.0 imports a grpc extension repo removed in newer grpc versions. diff --git a/MODULE.bazel.lock b/MODULE.bazel.lock index 5800b63..b3884ec 100644 --- a/MODULE.bazel.lock +++ b/MODULE.bazel.lock @@ -325,9 +325,10 @@ "https://bcr.bazel.build/modules/rules_multirun/0.9.0/source.json": "e882ba77962fa6c5fe68619e5c7d0374ec9a219fb8d03c42eadaf6d0243771bd", "https://bcr.bazel.build/modules/rules_multitool/0.11.0/MODULE.bazel": "8d9dda78d2398e136300d3ef4fbcc89ede7c32c158d8c016fa7d032df41c4aaf", "https://bcr.bazel.build/modules/rules_multitool/0.4.0/MODULE.bazel": "15517987d5c00c9e7faab41fbe22ee67a350b6eabcc1e08baded5c6d9025897f", + "https://bcr.bazel.build/modules/rules_multitool/1.11.1/MODULE.bazel": "f826d2d394e8d964e44ebb4a75ebcfe4e9cd4eb150e2ddcd60398ffeb939696a", + "https://bcr.bazel.build/modules/rules_multitool/1.11.1/source.json": "201f43de1d35bd17f25a4fed3ba5a2ec500ef5e08b7d4b341bb9fd39cef0cbc6", "https://bcr.bazel.build/modules/rules_multitool/1.2.0/MODULE.bazel": "8d818d6104f4030930291bbbbc5684702c237dbcdee7229097543e6a6035adaa", "https://bcr.bazel.build/modules/rules_multitool/1.9.0/MODULE.bazel": "8a042b0dbf35e4aaa94c28ad69efa75c9e673e9ea4bd5c0fb70bab75ef9c636b", - "https://bcr.bazel.build/modules/rules_multitool/1.9.0/source.json": "d9a01604a8b5c4a0e9430824dd34ca5b1b3f5b25277b755e8f3ae91f2c9362a3", "https://bcr.bazel.build/modules/rules_nodejs/5.8.2/MODULE.bazel": "6bc03c8f37f69401b888023bf511cb6ee4781433b0cb56236b2e55a21e3a026a", "https://bcr.bazel.build/modules/rules_nodejs/6.2.0/MODULE.bazel": "ec27907f55eb34705adb4e8257952162a2d4c3ed0f0b3b4c3c1aad1fac7be35e", "https://bcr.bazel.build/modules/rules_nodejs/6.3.0/MODULE.bazel": "45345e4aba35dd6e4701c1eebf5a4e67af4ed708def9ebcdc6027585b34ee52d", @@ -674,6 +675,7 @@ "https://raw.githubusercontent.com/eclipse-score/bazel_registry/main/modules/rules_multirun/0.9.0/MODULE.bazel": "not found", "https://raw.githubusercontent.com/eclipse-score/bazel_registry/main/modules/rules_multitool/0.11.0/MODULE.bazel": "not found", "https://raw.githubusercontent.com/eclipse-score/bazel_registry/main/modules/rules_multitool/0.4.0/MODULE.bazel": "not found", + "https://raw.githubusercontent.com/eclipse-score/bazel_registry/main/modules/rules_multitool/1.11.1/MODULE.bazel": "not found", "https://raw.githubusercontent.com/eclipse-score/bazel_registry/main/modules/rules_multitool/1.2.0/MODULE.bazel": "not found", "https://raw.githubusercontent.com/eclipse-score/bazel_registry/main/modules/rules_multitool/1.9.0/MODULE.bazel": "not found", "https://raw.githubusercontent.com/eclipse-score/bazel_registry/main/modules/rules_nodejs/5.8.2/MODULE.bazel": "not found", @@ -721,6 +723,8 @@ "https://raw.githubusercontent.com/eclipse-score/bazel_registry/main/modules/score_cr_checker/0.2.2/MODULE.bazel": "dc36d9c35543db918c3fb5b93a8e684431f56c7c784cf2a1b90f35802a373c98", "https://raw.githubusercontent.com/eclipse-score/bazel_registry/main/modules/score_cr_checker/0.3.1/MODULE.bazel": "f49e037d7fbc0b2a8b2734fc6b47334e8cc8589ca7a5aa0f3ccca85cc5f79fac", "https://raw.githubusercontent.com/eclipse-score/bazel_registry/main/modules/score_dash_license_checker/0.1.1/MODULE.bazel": "76681dbd2d45b5c540869a2337174086c56c54953aab1d02cd878b59d31d13a5", + "https://raw.githubusercontent.com/eclipse-score/bazel_registry/main/modules/score_devcontainer/1.5.0/MODULE.bazel": "c38b90903d66136ccd0559cf881508ef6c9430c119767a528fba95bda2b0a541", + "https://raw.githubusercontent.com/eclipse-score/bazel_registry/main/modules/score_devcontainer/1.5.0/source.json": "1cfbdab7f602eecec68f68a8c590872a3a80ff7011c056993a756b62aaf50e23", "https://raw.githubusercontent.com/eclipse-score/bazel_registry/main/modules/score_docs_as_code/0.2.4/MODULE.bazel": "ea4801e96c87e2b8650a0fa9e5fed9b8bdbef05c1bc3e30003ba527d5af60a43", "https://raw.githubusercontent.com/eclipse-score/bazel_registry/main/modules/score_docs_as_code/0.2.6/MODULE.bazel": "1af2963e91c6472555e222f0aba3dc2f5492d04598298209a361978ee3e321e3", "https://raw.githubusercontent.com/eclipse-score/bazel_registry/main/modules/score_docs_as_code/0.3.3/MODULE.bazel": "95d2b7d44d461c1cf9bd016605f740716fd4ea1303f5f2ed93de3566b90feb1b", @@ -736,8 +740,8 @@ "https://raw.githubusercontent.com/eclipse-score/bazel_registry/main/modules/score_docs_as_code/3.0.1/MODULE.bazel": "296328e60d5481ff529e0c937ba80c5d3d4838445d119caf517fd82f97cd053a", "https://raw.githubusercontent.com/eclipse-score/bazel_registry/main/modules/score_docs_as_code/4.0.0/MODULE.bazel": "522dc070354e6be2f984468a4243fe4ab8bec690922df5f31f7f0916ee264e20", "https://raw.githubusercontent.com/eclipse-score/bazel_registry/main/modules/score_docs_as_code/4.0.1/MODULE.bazel": "5955f4cf37228a9cdda7f6009b81db0446f005c618f4bc43665bfa45f2673ebc", - "https://raw.githubusercontent.com/eclipse-score/bazel_registry/main/modules/score_docs_as_code/4.0.3/MODULE.bazel": "ad24df8df93882297e36ecaa39a94a69eed68aeb5bb1614e85296d001d5e3c03", - "https://raw.githubusercontent.com/eclipse-score/bazel_registry/main/modules/score_docs_as_code/4.0.3/source.json": "b57557fbde8c66b870dc680f726df9074a734beec2ae9d79aca65127de5e1c42", + "https://raw.githubusercontent.com/eclipse-score/bazel_registry/main/modules/score_docs_as_code/4.2.0/MODULE.bazel": "c2157368008c43457aab3fd7a3329afa7390c7038a7eae75bd2b0d9d88f0f3e0", + "https://raw.githubusercontent.com/eclipse-score/bazel_registry/main/modules/score_docs_as_code/4.2.0/source.json": "4ded53c4749705a303b3f84c6175131ed1de7c2d0ee677f2a004c0d3ab4c9a07", "https://raw.githubusercontent.com/eclipse-score/bazel_registry/main/modules/score_format_checker/0.1.1/MODULE.bazel": "1acc254faa90e9f97b79ac69af25b6c21c561f8d6079914f6352b9b20d26bd37", "https://raw.githubusercontent.com/eclipse-score/bazel_registry/main/modules/score_platform/0.1.0/MODULE.bazel": "cc9eae86e76f2a930510ed6e50ec991bb5661687e24881685b39c322087adf6f", "https://raw.githubusercontent.com/eclipse-score/bazel_registry/main/modules/score_platform/0.1.1/MODULE.bazel": "eb086ba99f9319371fbbd0a9252dfd27b0817039b88bd4d691602974b1ada005", diff --git a/examples/docs/architecture_modeling_example.rst b/examples/docs/architecture_modeling_example.rst index 19efc55..e7650bf 100644 --- a/examples/docs/architecture_modeling_example.rst +++ b/examples/docs/architecture_modeling_example.rst @@ -193,7 +193,7 @@ Feature or Component Architecture File(s) :id: comp__mod_temp_component_example_1 :security: YES :safety: ASIL_B - :status: invalid + :status: valid :implements: logic_arc_int__example_feature__if_1 :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__mtef @@ -204,7 +204,7 @@ Feature or Component Architecture File(s) :id: comp__mod_temp_component_example_2 :security: YES :safety: ASIL_B - :status: invalid + :status: valid :implements: logic_arc_int__example_feature__if_2 :belongs_to: feat__mtef @@ -214,7 +214,7 @@ Feature or Component Architecture File(s) :id: comp__mod_temp_component_example_3 :security: YES :safety: QM - :status: invalid + :status: valid :implements: logic_arc_int__example_feature__if_3 :belongs_to: feat__mtef diff --git a/score/component_example/docs/architecture/index.rst b/score/component_example/docs/architecture/index.rst index 0965f3e..cd63b36 100644 --- a/score/component_example/docs/architecture/index.rst +++ b/score/component_example/docs/architecture/index.rst @@ -76,7 +76,7 @@ A component can optional also consist of lower level components to further struc :id: comp__mod_temp_component_name_template :security: YES :safety: ASIL_B - :status: invalid + :status: valid :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__mtef @@ -84,7 +84,7 @@ A component can optional also consist of lower level components to further struc :id: comp_arc_sta__mod_temp_component_name__sv :security: YES :safety: ASIL_B - :status: invalid + :status: valid :belongs_to: comp__mod_temp_component_name_template :fulfils: comp_req__mod_temp_component_name__some_title @@ -101,7 +101,7 @@ Dynamic Architecture :id: comp_arc_dyn__mod_temp_component_name__dv :security: YES :safety: ASIL_B - :status: invalid + :status: valid :belongs_to: comp__mod_temp_component_name_template :fulfils: comp_req__mod_temp_component_name__some_title @@ -125,7 +125,7 @@ Internal Components .. comp_arc_sta:: Component Name Static View :id: comp_arc_sta__mod_temp_component_name__2 - :status: invalid + :status: valid :safety: ASIL_B :security: YES :fulfils: comp_req__mod_temp_component_name__some_title diff --git a/score/component_example/docs/detailed_design/index.rst b/score/component_example/docs/detailed_design/index.rst index 0a18bcb..d980b37 100644 --- a/score/component_example/docs/detailed_design/index.rst +++ b/score/component_example/docs/detailed_design/index.rst @@ -17,6 +17,11 @@ Detailed Design ############### +.. attention:: + + The detailed design document is optional and should be created if the design of the component is complex and cannot be easily understood from the architecture documentation and interface documentation alone. + + .. document:: [Your Component Name] Detailed Design :id: doc__mod_temp_component_name_detailed_design :status: draft diff --git a/score/component_example/docs/requirements/index.rst b/score/component_example/docs/requirements/index.rst index c1928bd..267cd0a 100644 --- a/score/component_example/docs/requirements/index.rst +++ b/score/component_example/docs/requirements/index.rst @@ -43,7 +43,7 @@ Component Requirements :security: YES :safety: ASIL_B :satisfies: feat_req__example_feature__example_req - :status: invalid + :status: valid :belongs_to: comp__mod_temp_component_name_template The Component shall do xyz to another component to bring it to this condition at this time @@ -68,7 +68,7 @@ Assumption of Use Requirements :reqtype: Process :security: YES :safety: ASIL_B - :status: invalid + :status: valid The Component User shall do xyz to use the component safely/securely