Skip to content

Conversation

@damianphim
Copy link

Closes #34

Demo and First-Time Building Overhaul

Previously, there was no documentation for any of the demos and the Space ROS documentation was outdated, so it took me like 3 days (embarrassing I know) to just build and get the demos running without any errors.

This PR updates the First-Time Building Space ROS page in the documentation (Tutorials -> First-Time Building Space ROS) to the latest method. In addition, it adds documentation for building and running MoveIt2, the Canadarm Demo, and the Curiosity Mars Rover demo.

I'm hoping this PR helps any future contributors not run into the same wall that I did!

@130s
Copy link

130s commented Sep 11, 2024

it took me like 3 days (embarrassing I know) to just build and get the demos running without any errors.

Not just you, I spent a day and haven't been able to see Mars rover on a simulator yet :/

I see this PR is updating .rst files. I asked why space_ros uses rst space-ros/space-ros#210 (I'm not against it, it just raises hurdle IMO).

@damianphim
Copy link
Author

Not just you, I spent a day and haven't been able to see Mars rover on a simulator yet :/

Sounds like you made more progress than me on my first day, don't give up!

I see this PR is updating .rst files. I asked why space_ros uses rst space-ros/space-ros#210 (I'm not against it, it just raises hurdle IMO).

I believe the ROS 2 documentation also uses .rst files, which could be it.

@damianphim damianphim force-pushed the add-demo-documentation branch from 1b8bb56 to 1b8a062 Compare September 12, 2024 19:58
@Bckempa Bckempa self-requested a review September 19, 2024 08:47
@ivanperez-keera
Copy link
Contributor

ivanperez-keera commented Mar 6, 2025

EDIT: I've applied this change to the PR.

@damianphim Can you please remove the file source/Getting-Started/.Building-From-Source.rst.swp?

This looks like a temporary (vim?) file that was introduced by mistake.

@ivanperez-keera
Copy link
Contributor

I have not checked the accuracy of each step but, at first glance, this looks great and (almost) ready to merge, except for my two comments above.

Can I suggest @Bckempa to review the docker build steps, and @xfiderek to review the IKOS steps?

@ivanperez-keera
Copy link
Contributor

ivanperez-keera commented Mar 6, 2025

EDIT: I've applied this change to the PR.

@damianphim Can you please also squash the two commits (since the second just fixes things about the first commit), and rephrase the commit message to be:

Create instructions for MoveIt2 image and two demos, and update first time build instructions (#34).

This commit creates documentation to build the MoveIt2 image, and to build and
run the Canadaarm and Mars Curiosity demos.

It also updates the First-Time Build Tutorial with build instructions, and
steps to run commands in a Space ROS image, to build the tests, and to run
generate the reports from IKOS.

Another suggestion, is the order of sections in the first time build tutorial ideal? Should connecting to a container come before generating tests? (it's a bit strange to me that it comes between the tests and IKOS).

… time build instructions (space-ros#34).

This commit creates documentation to build the MoveIt2 image, and to build and
run the Canadaarm and Mars Curiosity demos.

It also updates the First-Time Build Tutorial with build instructions, and
steps to run commands in a Space ROS image, to build the tests, and to run
generate the reports from IKOS.
@ivanperez-keera ivanperez-keera force-pushed the add-demo-documentation branch from 1b8a062 to e987f91 Compare March 9, 2025 16:31
@ivanperez-keera
Copy link
Contributor

ivanperez-keera commented Mar 9, 2025

I've updated the PR with the changes I was proposing, leaving the original committer as author.

@Bckempa, @xfiderek, @asimonov, please let me know if anything needs to change. Otherwise we can merge this (with --no-ff) as is and close #34.

@Bckempa
Copy link
Contributor

Bckempa commented Mar 12, 2025

@ivanperez-keera, I've got journal and SBIR reviews occupying my next few evenings but I'll get to this before the weekend.

Copy link

@asimonov asimonov left a comment

Choose a reason for hiding this comment

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

I have looked through the changes and they look correct!

@ivanperez-keera ivanperez-keera self-requested a review March 14, 2025 17:39
@ivanperez-keera ivanperez-keera merged commit 3850721 into space-ros:rolling Mar 18, 2025
2 checks passed
@github-project-automation github-project-automation bot moved this from In Review to Done in Space ROS Project Development Mar 18, 2025
@ivanperez-keera ivanperez-keera removed the request for review from Bckempa March 18, 2025 03:55
@ivanperez-keera ivanperez-keera added this to the jazzy-2025.04.0 milestone Mar 18, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

Update First-Time Build Tutorial

6 participants