docs: update to supported formats#124
Conversation
- move md to rst - regenerate diagrams in plantuml
PiotrKorkus
requested a deployment
to
workflow-approval
GitHub Actions
Waiting
PiotrKorkus
requested a deployment
to
workflow-approval
GitHub Actions
Waiting
License Check Results🚀 The license check job ran with the Bazel command: bazel run --lockfile_mode=error //:license-checkStatus: Click to expand output |
|
The created documentation from the pull request is available at: docu-html |
|
@NicolasFussberger / @SimonKozik can you have a look |
|
|
||
| module/*/index | ||
| module/lifecycle_client_lib/lifecycle | ||
| module/lifecycle_client_lib/lifecyclemanager |
There was a problem hiding this comment.
I think we should introduce a subfolder for launch_manager here inbetween.
Otherwise, these lifecycle_client_lib APIs are visible at the top-level:
| } | ||
|
|
||
| App --|> mwApp : <<uses>> | ||
| App --> LifecycleManager : manages (run, terminate) |
There was a problem hiding this comment.
direction of the arrow is wrong
| class "Application Context" as AppCtx #0000FF { | ||
| } | ||
|
|
||
| App --|> mwApp : <<uses>> |
There was a problem hiding this comment.
original diagram says App --> mwApp : implements
and it is not an inheritance arrow but an implements arrow
|
|
||
| LifecycleManager --> ExecMgr : reports state (run, terminate) | ||
| LifecycleManager --> OS : handles application SIGTERM | ||
|
|
There was a problem hiding this comment.
The original diagram also depicted this link:
ExecMgr --> LifecycleManager : handles application SIGTERM
| LifecycleManager --> ExecMgr : reports state (run, terminate) | ||
| LifecycleManager --> OS : handles application SIGTERM | ||
|
|
||
| AppCtx --> ExecMgr : starts |
There was a problem hiding this comment.
The direction of the arrow is wrong
| mw::lifecycle | ||
| end note | ||
|
|
||
| @enduml |
There was a problem hiding this comment.
@PiotrKorkus would you be so kind to check the other diagrams first?
It seems the AI conversion introduced a bunch of errors.
You can use umlet-standalone to view the original uxf diagrams
|
thanks for checking those diagrams. Those changes are needed for reference_integration build as lifecycle blocks building its documentation there. |
We discussed in the last lifecycle meeting that @jaakkoaho will have a look at these changes. |
3 participants
Please double check diagrams, as I used AI to convert them into PlantUML and they were not rendered anywhere for comparison.
Bugfix
Important
Use this template only for bugfixes that do not influence topics covered by contribution requests or improvements.
Caution
Make sure to submit your pull-request as Draft until you are ready to have it reviewed by the Committers.
Description
[A short description of the bug being fixed by the contribution.]
Related ticket
Important
Please replace
[ISSUE-NUMBER]with the issue-number that tracks this bug fix. If there is no suchticket yet, create one via this issue template.
closes [ISSUE-NUMBER] (bugfix ticket)