Update install docs #609
Update install docs #609
Conversation
Fix creation of ~ folder and ssh key setup guide
WalkthroughThe pull request introduces modifications to two documentation files related to setup instructions for CL simulation testing and the installation of ROS2 Iron Irwini on Ubuntu 22.04. The changes include enhanced clarity in the setup steps, detailed prerequisites, and improved formatting for links and commands. Sections have been added or expanded to provide users with comprehensive guidance on SSH key setup, directory creation, compilation, and debugging tools, as well as a streamlined installation process for ROS2. Changes
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Outside diff range and nitpick comments (2)
bitbots_misc/bitbots_docs/docs/manual/tutorials/install_software_ros2.rst (2)
73-73: LGTM! Consider these minor improvements for clarity.The SSH key setup instructions are clear and well-structured. Consider these enhancements:
- Use a relative link for the bit-bots documentation instead of an absolute URL to prevent broken links if the domain changes
- Add a note about supported SSH key types (Ed25519 is recommended)
Apply this change to use a relative link:
-see `here <http://doku.bit-bots.de/private/manual/dienste_accounts.html>`_ +see :doc:`here <../dienste_accounts>`
73-73: Enhance documentation of environment variables.The "Final touches" section could benefit from additional documentation:
- Add comments explaining the purpose of
ROS_DOMAIN_ID=24and when users might need to change it- Document the significance of
COLCON_LOG_LEVEL=30- Consider adding a troubleshooting section for common setup issues
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (2)
bitbots_misc/bitbots_docs/docs/manual/tutorials/cl_simulation_testing_setup.rst(1 hunks)bitbots_misc/bitbots_docs/docs/manual/tutorials/install_software_ros2.rst(1 hunks)
🔇 Additional comments (1)
bitbots_misc/bitbots_docs/docs/manual/tutorials/cl_simulation_testing_setup.rst (1)
17-19: LGTM: Clear and comprehensive SSH setup instructions.
The added SSH key setup instructions are well-structured and provide excellent guidance, including:
- Link to official GitHub documentation for new users
- Clear specification of using the
.pubfile - Proper RST formatting for external links
bitbots_misc/bitbots_docs/docs/manual/tutorials/cl_simulation_testing_setup.rst
Outdated
Show resolved
Hide resolved
| **3. Download our software** | ||
|
|
||
| - Create a GitHub account, if not already done (see `here <http://doku.bit-bots.de/private/manual/dienste_accounts.html>` for further information) | ||
| - Create a GitHub account, if not already done (see `here <http://doku.bit-bots.de/private/manual/dienste_accounts.html>`_ for further information) |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Add security best practices for SSH key setup.
Consider adding these security-related notes:
- Set correct permissions for SSH keys:
chmod 600 ~/.ssh/id_ed25519 - Never share or expose your private key
- Use a strong passphrase for your SSH key
…testing_setup.rst Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
jaagut
left a comment
jaagut
left a comment
There was a problem hiding this comment.
As code rabbit suggested, we should consider using more relative links.
Also, after the install ros step with concatenating the bashrc: one has to either
- source bashrc manually,
- close the session, reopen and the next step still assumes, we are in the ws/src/bitbots_main directory which we are not
- or call bash again
I think, sourcing is the cleanest option. We should add this to the install ros doc
I agree, but I think this is out of scope for this PR. |
Auto source new .bashrc
Summary
Fix ~ folder issue, links and ssh setup