Skip to content

docs: consolidate mw/log design diagrams into docs/components/ - #190

Open
RSingh1511 wants to merge 1 commit into
eclipse-score:mainfrom
RSingh1511:rs/consolidate-docs-puml
Open

docs: consolidate mw/log design diagrams into docs/components/#190
RSingh1511 wants to merge 1 commit into
eclipse-score:mainfrom
RSingh1511:rs/consolidate-docs-puml

Conversation

@RSingh1511

Copy link
Copy Markdown
Contributor

Notes for Reviewer

Pre-Review Checklist for the PR Author

  • PR title is short, expressive and meaningful
  • Commits are properly organized
  • Relevant issues are linked in the References section
  • Tests are conducted
  • Unit tests are added

Checklist for the PR Reviewer

  • Commits are properly organized and messages are according to the guideline
  • Unit tests have been written for new behavior
  • Public API is documented
  • PR title describes the changes

Post-review Checklist for the PR Author

  • All open points are addressed and tracked via issues

References

Closes #

@github-actions

github-actions Bot commented Jul 15, 2026

Copy link
Copy Markdown

License Check Results

🚀 The license check job ran with the Bazel command:

bazel run --lockfile_mode=error //:license-check

Status: ⚠️ Needs Review

Click to expand output
[License Check Output]
Extracting Bazel installation...
Starting local Bazel server (8.6.0) and connecting to it...
INFO: Invocation ID: dec0dbae-ef94-4906-8f59-375098ff0fee
Computing main repo mapping: 
Computing main repo mapping: 
WARNING: For repository 'score_process', the root module requires module version score_process@1.5.4, but got score_process@1.6.0 in the resolved dependency graph. Please update the version in your MODULE.bazel or set --check_direct_dependencies=off
WARNING: For repository 'score_crates', the root module requires module version score_crates@0.0.9, but got score_crates@0.0.10 in the resolved dependency graph. Please update the version in your MODULE.bazel or set --check_direct_dependencies=off
Computing main repo mapping: 
Computing main repo mapping: 
Computing main repo mapping: 
Loading: 
Loading: 4 packages loaded
Loading: 4 packages loaded
    currently loading: 
Loading: 4 packages loaded
    currently loading: 
WARNING: Target pattern parsing failed.
ERROR: Skipping '//:license-check': no such target '//:license-check': target 'license-check' not declared in package '' defined by /home/runner/work/logging/logging/BUILD
ERROR: no such target '//:license-check': target 'license-check' not declared in package '' defined by /home/runner/work/logging/logging/BUILD
INFO: Elapsed time: 10.012s
INFO: 0 processes.
ERROR: Build did NOT complete successfully
ERROR: Build failed. Not running target

@RSingh1511
RSingh1511 requested a review from mobileinfo July 16, 2026 06:08

@mobileinfo mobileinfo left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

I assume we agreed using component name log_frontend, log_backend and datarouter, please see https://github.com/orgs/eclipse-score/discussions/3084, @arsibo please confirm

.. document:: Data Router Detailed Design
:id: doc__data_router_detailed_design
:status: valid
:safety: ASIL_B

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

datarouter is a QM component

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Done

.. document:: mw/log Detailed Design
:id: doc__mw_logging_detailed_design
:status: valid
:safety: ASIL_B

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

ASIL_B or FFI?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

ASIL_B.

@anmittag anmittag linked an issue Jul 28, 2026 that may be closed by this pull request
@RSingh1511
RSingh1511 force-pushed the rs/consolidate-docs-puml branch from aa6884d to aa341f5 Compare July 28, 2026 09:50
@RSingh1511
RSingh1511 force-pushed the rs/consolidate-docs-puml branch from aa341f5 to 7ffebae Compare July 28, 2026 10:02
@RSingh1511
RSingh1511 marked this pull request as ready for review July 28, 2026 13:05
@RSingh1511
RSingh1511 force-pushed the rs/consolidate-docs-puml branch from 7ffebae to 45e67de Compare July 28, 2026 17:15
@@ -0,0 +1,249 @@
@startuml configuration_static

interface "bmw:mw::log::Recorder" as Recorder {

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Suggested change
interface "bmw:mw::log::Recorder" as Recorder {
interface "score:mw::log::Recorder" as Recorder {

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Done.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Backlog

Development

Successfully merging this pull request may close these issues.

Consolidate mw/log design documentation into docs/

2 participants