-
Notifications
You must be signed in to change notification settings - Fork 8
Added docs on how to set up VM on Mac for Linux to flash RB3 board #9
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
base: main
Are you sure you want to change the base?
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
This pull request adds two new documentation files to guide developers in setting up a development environment for flashing the RB3 board: a VM setup guide for Intel-based Macs using UTM virtualization (VM_mac.rst) and a Docker installation guide for the RB3 board (Docker.rst).
Key Changes:
- New VM setup guide for macOS users providing step-by-step instructions for creating an Ubuntu VM on Intel Macs
- New Docker installation and configuration guide specific to the RB3 board (ARM64 architecture)
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 26 comments.
| File | Description |
|---|---|
| docs/source/VM_mac.rst | Adds comprehensive documentation for setting up Ubuntu VM on Intel-based Macs using UTM, including clipboard sharing and USB passthrough configuration |
| docs/source/Docker.rst | Adds Docker installation, verification, and configuration instructions for the RB3 board environment |
Issues Found:
The Docker.rst file contains significant formatting issues. The file incorrectly mixes Markdown and reStructuredText syntax throughout:
- The title uses Markdown syntax (#) instead of RST underlined format
- All code blocks are wrapped in triple backticks (```), which is Markdown syntax not reStructuredText
- Numbered list items use backslash-escaped numbers (2., 3., 4.) instead of plain numbers
The VM_mac.rst file appears to follow proper RST formatting conventions and contains no issues.
These formatting problems will prevent the documentation from rendering correctly in Sphinx and should be corrected to use proper RST syntax consistently throughout the Docker.rst file.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| sudo apt install apt-transport-https ca-certificates curl software-properties-common -y | ||
| ``` | ||
|
|
||
| 2\. **Add the Docker GPG key** |
Copilot
AI
Dec 10, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The section numbering uses "2." with a backslash. In reStructuredText, numbered lists should use plain numbers without escaping (e.g., "2."). The backslash is likely unintended.
| sudo usermod -aG docker $USER | ||
| ``` | ||
|
|
||
| 2\. **Apply the group changes** (This step is critical to avoid permission issues): |
Copilot
AI
Dec 10, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The section numbering uses "2." with a backslash. In reStructuredText, numbered lists should use plain numbers without escaping (e.g., "2."). The backslash is likely unintended.
| 2\. **Apply the group changes** (This step is critical to avoid permission issues): | |
| 2. **Apply the group changes** (This step is critical to avoid permission issues): |
|
|
||
| .. code-block:: bash | ||
|
|
||
| ``` |
Copilot
AI
Dec 10, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Code blocks should not be wrapped in triple backticks (```). This is Markdown syntax. In reStructuredText with the code-block directive, the code should directly follow the directive without backticks.
|
|
||
| ``` | ||
| echo "deb [arch=arm64 signed-by=/usr/share/keyrings/docker-archive-keyring.gpg] https://download.docker.com/linux/ubuntu $(lsb_release -cs) stable" | sudo tee /etc/apt/sources.list.d/docker.list > /dev/null | ||
| ``` |
Copilot
AI
Dec 10, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Code blocks should not be wrapped in triple backticks (```). This is Markdown syntax. In reStructuredText with the code-block directive, the code should directly follow the directive without backticks.
|
|
||
| .. code-block:: bash | ||
|
|
||
| ``` |
Copilot
AI
Dec 10, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Code blocks should not be wrapped in triple backticks (```). This is Markdown syntax. In reStructuredText with the code-block directive, the code should directly follow the directive without backticks.
| newgrp docker | ||
| ``` | ||
|
|
||
| 3\. **Test the configuration** |
Copilot
AI
Dec 10, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The section numbering uses "3." with a backslash. In reStructuredText, numbered lists should use plain numbers without escaping (e.g., "3."). The backslash is likely unintended.
|
|
||
| .. code-block:: bash | ||
|
|
||
| ``` |
Copilot
AI
Dec 10, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Code blocks should not be wrapped in triple backticks (```). This is Markdown syntax. In reStructuredText with the code-block directive, the code should directly follow the directive without backticks.
|
|
||
| ``` | ||
| docker --version | ||
| ``` |
Copilot
AI
Dec 10, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Code blocks should not be wrapped in triple backticks (```). This is Markdown syntax. In reStructuredText with the code-block directive, the code should directly follow the directive without backticks.
| ``` | ||
| Docker version xx.xx.xx, build 1234567 | ||
| ``` |
Copilot
AI
Dec 10, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Triple backticks (```) should not be used in reStructuredText. The previous line uses the :: syntax for a literal block, which is correct. The code content should be indented without backticks.
| .. code-block:: bash | ||
|
|
||
| ``` | ||
| sudo usermod -aG docker $USER |
Copilot
AI
Dec 10, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Adding the current user to the docker group (sudo usermod -aG docker $USER) effectively grants that user root-equivalent privileges on the host, since docker group members can start privileged containers, mount the host filesystem, and gain full control of the system. An attacker who compromises any process running as this user could escalate to root by running a crafted docker run command. If possible, prefer using sudo for specific docker commands or clearly document that joining the docker group is a privileged, admin-only action with security implications.
No description provided.