Repository navigation
Update the First Time Building tutorial for the current build (#43). - #54
Open
EmbryoSpace wants to merge 1 commit into
Open
EmbryoSpace wants to merge 1 commit into
EmbryoSpace wants to merge 1 commit into
Conversation
…ros#43). The tutorial still describes the Earthly-based build (Earthly, Ubuntu 22.04, `earthly +repos-file`, `exact.repos` in /opt/spaceros), which the space-ros repository no longer uses, so following it fails. This commit rewrites it to follow space-ros/space-ros docs/USAGE.md, as suggested in space-ros#43: building with `./build.sh` and docker buildx, the main and dev variants, running the image, preparing a workspace from `${SPACEROS_DIR}/scripts/spaceros.repos`, and rebuilding and testing with colcon. It also mentions the pre-built images on Docker Hub, updates the "connect another terminal" section to the container name used by run.sh, and links to the IKOS and reproducible builds docs in the space-ros repository instead of repeating them. The page anchor is unchanged, so existing links keep working.
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #43.
As @asimonov noted in #43, the First Time Building tutorial still describes the Earthly-based build (Earthly, Ubuntu 22.04,
earthly +repos-file,exact.reposin/opt/spaceros), which space-ros/space-ros no longer uses.This rewrites the page to follow space-ros/space-ros
docs/USAGE.mdand links to it as the reference:./build.sh/SPACE_ROS_VARIANT=dev ./build.shmainanddevvariants, and the pre-built images on Docker Hub (including the-devrelease tags)run.sh${SPACEROS_DIR}/scripts/spaceros.repos, then rebuilding and testing with colconosrf_space-roscontainer name thatrun.shusesIKOS.mdandREPRODUCIBLE.mdin space-ros instead of repeating themThe page anchor is unchanged, so existing links (Getting Started, demo pages) keep working. It does not touch the files in #35.
Checks: in
osrf/space-ros:jazzy-2026.07.0I confirmedSPACEROS_DIR=/opt/ros/spaceros,scripts/spaceros.repos, Ubuntu 24.04,vcs/colconpresent, and that an interactivedocker execshell hasros2on the path.doc8 --ignore D001passes andsphinx -M htmlbuilds the page with no warnings from it (pinned versions frompixi.toml). I did not run a full workspace rebuild.