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

docs(docker): description of how to use the development and runtime containers #5301

Merged
merged 5 commits into from
Oct 4, 2024

Conversation

youtalk
Copy link
Member

@youtalk youtalk commented Oct 3, 2024

Description

This PR briefly describes how to use the development containers and runtime containers.

Tests performed

Not applicable.

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.

youtalk and others added 5 commits October 3, 2024 14:12
Signed-off-by: Yutaka Kondo <yutaka.kondo@youtalk.jp>
Signed-off-by: Yutaka Kondo <yutaka.kondo@youtalk.jp>
Signed-off-by: Yutaka Kondo <yutaka.kondo@youtalk.jp>
Signed-off-by: Yutaka Kondo <yutaka.kondo@youtalk.jp>
@youtalk youtalk marked this pull request as ready for review October 3, 2024 09:53
@youtalk youtalk added type:containers Docker containers, containerization of components, or container orchestration. component:openadkit Issues or Features related to Open AD Kit tag:run-health-check Run health-check labels Oct 3, 2024
@youtalk youtalk self-assigned this Oct 3, 2024
@mitsudome-r
Copy link
Member

mitsudome-r commented Oct 3, 2024

Thanks for the PR!
I think it is useful for many users to have this how-to-guides.

However, I think it might be better to update the usage section (source code) under the Autoware Documentation because that would be more visible for more people. We can still keep this README as a place to explain the design and description of the docker image creation pipeline, and just add a link to the Autoware Documentation page as a user guide.

The link I shared has instructions to run the docker from the script, but I think we can update it to have more detailed instruction to call the docker run command as well.

@youtalk
Copy link
Member Author

youtalk commented Oct 4, 2024

@mitsudome-r Exactly! But the current Open AD Kit document seems to be obsolete.
https://autowarefoundation.github.io/open-ad-kit-docs/openadkit_v3/version-3.0/
https://autowarefoundation.github.io/autoware-documentation/main/installation/autoware/docker-installation/#usage

I would like to update the whole pages after Docker Compose configuration will be done. #5182
Therefore, until then, please temporarily provide the simplified summary for developers in this README.md.

@mitsudome-r
Copy link
Member

@youtalk
If you are aware of other pages and are thinking of updating them later, then I'm okay with approving this PR.

@youtalk youtalk merged commit 6812e5e into main Oct 4, 2024
29 of 30 checks passed
@youtalk youtalk deleted the container-readme branch October 4, 2024 05:19
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