Add a tip about detach development docker image in the installation section #681
Description
Checklist
- I've read the contribution guidelines.
- I've searched other issues and no duplicate issues were found.
- I've agreed with the maintainers that I can plan this task.
Description
I am new to Autoware, and the installation documentation confused me and I encountered some issues.
I spent a long while upgrading packages and building the workspace, and also spent time resolving some build issues. After inputting exit as is normally done in other open source projects' docker containers, the container was automatically deleted.
Then I realized this container is deleted and only /workspace files, including build binaries, are kept as they are mounted. But all other system configurations and packages are lost.
This behaviour is expected and understandable, but it would be better to let the user know this behaviour will happen and let the user exit the container elegantly and continue their work next time.
Purpose
To better clarify the development container usage and help users avoid removing the container accidentally.
Possible approaches
Add a section in the Development environment to describe how to detach and attach the container.
For exiting the development container, you may want to detach from using the CTRL-p CTRL-q key sequence to avoid losing modifications.
You can use docker attach CONTAINER or docker exec -it CONTAINER bash to reconnect to the container. For more information, please refer to docker container attach.
Alternatively, can find a solution to update our Dockerfile / run script to keep the container. For example, in the ./docker/run.sh script, let it start the container, and execute a new bash for the user to use. Furthermore, we can also let the script run and find the container, which helps the user to use the same development container every time. This solution is more elegant and more user friendly.
Once this is confirmed, I can open an issue in the autoware repo to describe this issue.
Definition of done
Update the documentation, or Dockfiles / run script / configs.