Skip to content
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.

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

feat(docker): add mermaid diagram for openadkit containers #5276

Closed
wants to merge 1 commit into from

Conversation

oguzkaganozt
Copy link
Contributor

@oguzkaganozt oguzkaganozt commented Sep 24, 2024

Description

Add mermaid diagram for docker containers

Tests performed

Here is the mermaid diagram output on Readme: https://github.com/autowarefoundation/autoware/tree/add-mermaid-diagram-openadkit/docker

mermaid

Effects on system behavior

Not applicable.

Interface changes

Pre-review checklist for the PR author

The PR author must check the checkboxes below when creating the PR.

In-review checklist for the PR reviewers

The PR reviewers must check the checkboxes below before approval.

Post-review checklist for the PR author

The PR author must check the checkboxes below before merging.

  • There are no open discussions or they are tracked via tickets.

After all checkboxes are checked, anyone who has write access can merge the PR.

@oguzkaganozt oguzkaganozt added type:containers Docker containers, containerization of components, or container orchestration. component:openadkit Issues or Features related to Open AD Kit labels Sep 24, 2024
@oguzkaganozt oguzkaganozt self-assigned this Sep 24, 2024
@oguzkaganozt oguzkaganozt added the tag:run-health-check Run health-check label Sep 24, 2024
Copy link
Member

@youtalk youtalk left a comment

Choose a reason for hiding this comment

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

I automatically export the Dockerfile.svg from Dockerfile by https://github.com/patrickhoefler/dockerfilegraph.
I don't want to do the double maintenance between the Dockerfile and the mermaid file.

@oguzkaganozt
Copy link
Contributor Author

I automatically export the Dockerfile.svg from Dockerfile by https://github.com/patrickhoefler/dockerfilegraph. I don't want to do the double maintenance between the Dockerfile and the mermaid file.

That's even better, thanks for the heads up

@oguzkaganozt oguzkaganozt deleted the add-mermaid-diagram-openadkit branch September 27, 2024 09:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component:openadkit Issues or Features related to Open AD Kit tag:run-health-check Run health-check type:containers Docker containers, containerization of components, or container orchestration.
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

2 participants