8000 docs: initial draft architecture design process by hoe-jo · Pull Request #500 · eclipse-score/score · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

docs: initial draft architecture design process #500

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 3 commits into from
Mar 7, 2025
Merged

docs: initial draft architecture design process #500

merged 3 commits into from
Mar 7, 2025

Conversation

hoe-jo
Copy link
Contributor
@hoe-jo hoe-jo commented Feb 25, 2025
  • guideline
  • getting startet
  • workflow/workproducts
  • guidances

resolves #311

@github-actions GitHub Actions
Copy link

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

@hoe-jo hoe-jo requested a review from masc2023 February 25, 2025 12:59
aschemmel-tech
aschemmel-tech reviewed Feb 25, 2025
View reviewed changes
Copy link
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.

OSS review is fine, content review will follow.

aschemmel-tech
aschemmel-tech requested changes Feb 28, 2025
View reviewed changes
Copy link
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.

See inline comments.

docs/process/guidance/general/index.rst Outdated
@@ -118,7 +118,7 @@ can be in a different order.
components/ -> Components of the module.
<component_name>/ -> Folder containing all artifacts corresponding to one component.
docs/ -> Documentation of the component consisting of ...
architecture/ -> ... Component architecture (only if sub-components exist) [wp__sw_component_architecture].
architecture/ -> ... Component architecture (only if sub-components exist) [wf__cr_mt_comparch].
Copy link
Contributor

Choose a reason for hiding this comment

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

should refer to a "wp" not "wf"

Copy link
Contributor

Choose a reason for hiding this comment

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

still open

docs/process/process_areas/architecture_design/_assets/architecture_workflow.svg Outdated
Copy link
Contributor

Choose a reason for hiding this comment

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

Why introduce another term "HLA"? Is it something else than the feature architecture?

docs/process/process_areas/architecture_design/_assets/architecture_workflow.svg Outdated
Copy link
Contributor

Choose a reason for hiding this comment

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

shouldn't we show that the architecture is developed based on the requirements? Here it looks a bit like we "model" an architecture and as a second step link it to requirements.

docs/process/process_areas/architecture_design/guidance/architecture_guideline.rst Outdated
Allocate feature requirements to architectural elements
-------------------------------------------------------

In the next step the already derived feature requirements shall be allocated to the architectural elements. If needed also additional feature requirements, which may arise due to architectural decisions, should be created and allocated to the stakeholder requirements.
Copy link
Contributor

Choose a reason for hiding this comment

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

What are the architecture elements the requirements shall be allocated to?

masc2023
masc2023 requested changes Mar 3, 2025
View reviewed changes
Copy link
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.

Please use Software Module and Components everywhere, as defined in the Build Blocks Meta Model

@hoe-jo
docs: initial draft architecture design process
c1e2ec6 
- guideline
- getting startet
- workflow/workproducts
- guidances

resolves #311
@hoe-jo hoe-jo force-pushed the hoe_jo_initial_draft_architecture_process branch from 0721c65 to c1e2ec6 Compare March 6, 2025 09:34
@github-actions GitHub Actions
Copy link
github-actions bot commented Mar 6, 2025 •
edited
Loading

License Check Results

🚀 The license check preparation job ran successfully.

Status: ⚠️ Needs Review

Click to expand output 
2025/03/07 08:40:04 Downloading https://releases.bazel.build/7.4.0/release/bazel-7.4.0-linux-x86_64...
Extracting Bazel installation...
Starting local Bazel server and connecting to it...
Computing main repo mapping: 
Computing main repo mapping: 
Computing main repo mapping: 
Loading: 
Loading: 0 packages loaded
Loading: 0 packages loaded
    currently loading: docs
Loading: 0 packages loaded
    currently loading: docs
Loading: 0 packages loaded
    currently loading: docs
Analyzing: target //docs:license.check.python (1 packages loaded, 0 targets configured)
Analyzing: target //docs:license.check.python (1 packages loaded, 0 targets configured)

Analyzing: target //docs:license.check.python (93 packages loaded, 10 targets configured)

Analyzing: target //docs:license.check.python (112 packages loaded, 203 targets configured)

Analyzing: target //docs:license.check.python (132 packages loaded, 887 targets configured)

Analyzing: target //docs:license.check.python (144 packages loaded, 2334 targets configured)

Analyzing: target //docs:license.check.python (144 packages loaded, 2465 targets configured)

Analyzing: target //docs:license.check.python (144 packages loaded, 2465 targets configured)

INFO: Analyzed target //docs:license.check.python (149 packages loaded, 4736 targets configured).
[7 / 13] [Prepa] Creating runfiles tree bazel-out/k8-opt-exec-ST-d57f47055a04/bin/tools/dash/formatters/dash_format_converter.runfiles [for tool]
[10 / 13] JavaToolchainCompileClasses external/rules_java~/toolchains/platformclasspath_classes; 0s processwrapper-sandbox
[11 / 13] JavaToolchainCompileBootClasspath external/rules_java~/toolchains/platformclasspath.jar; 0s processwrapper-sandbox
INFO: Found 1 target...
Target //docs:license.check.python up-to-date:
  bazel-bin/docs/license.check.python
  bazel-bin/docs/license.check.python.jar
INFO: Elapsed time: 19.196s, Critical Path: 2.59s
INFO: 13 processes: 9 internal, 3 processwrapper-sandbox, 1 worker.
INFO: Build completed successfully, 13 total actions
INFO: Running command line: bazel-bin/docs/license.check.python docs/formatted.txt -review -project automotive.score -repo https://github.com/eclipse-score/score -token otyhZ4eaRYK1tKLNNF-Y
[main] INFO Querying Eclipse Foundation for license data for 69 items.
[main] INFO Found 45 items.
[main] INFO Querying ClearlyDefined for license data for 43 items.
[main] ERROR Error response from ClearlyDefined 429

@hoe-jo hoe-jo force-pushed the hoe_jo_initial_draft_architecture_process branch from 7171523 to 187ed56 Compare March 7, 2025 08:39
masc2023
masc2023 approved these changes Mar 7, 2025
View reviewed changes
Copy link
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.

As initial draft ok now

aschemmel-tech
aschemmel-tech approved these changes Mar 7, 2025
View reviewed changes
Copy link
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.

Last open topics (wp_ replace wf_ in folder structure, "HLA" in workflow picture and component requirements at same time as the component architecture (also wf picture) will be fixed in followup PR

@hoe-jo hoe-jo merged commit d752cf3 into main Mar 7, 2025
9 of 10 checks passed
@hoe-jo hoe-jo deleted the hoe_jo_initial_draft_architecture_process branch March 7, 2025 14:06
@masc2023 masc2023 linked an issue Mar 10, 2025 that may be closed by this pull request < 84F1 /div>
Epic: (Initial) Processes Architecture #610
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@pahmann pahmann pahmann left review comments

@masc2023 masc2023 masc2023 approved these changes

@aschemmel-tech aschemmel-tech aschemmel-tech approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Epic: (Initial) Processes Architecture Improvement: Document architecture process
4 participants
@hoe-jo @pahmann @masc2023 @aschemmel-tech
0