-
Notifications
You must be signed in to change notification settings - Fork 14
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
Add Jazzy documentation #26
Open
civerachb-cpr
wants to merge
44
commits into
gh-pages
Choose a base branch
from
jazzy
base: gh-pages
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+2,811
−252
Open
Changes from all commits
Commits
Show all changes
44 commits
Select commit
Hold shift + click to select a range
aa48816
Start adding Jazzy docs
civerachb-cpr cc55660
Change Nav2 links to docs.nav2.org. Addresses https://github.com/turt…
civerachb-cpr 1d5d7a6
Update README with changes for Ubuntu 24.04, modify the debug configu…
civerachb-cpr d5da836
Bump major version for Jazzy
civerachb-cpr 22397aa
More jazzy sections added
civerachb-cpr 682eb75
Fix bad tab delimiter, update visualization package
civerachb-cpr 8c4da95
Add Jazzy section to create3.md
civerachb-cpr 88d6886
Add a note about firmware versions needing to match the ROS release
civerachb-cpr 1bb5bd9
Remove the note about letter prefixes; it doesn't matter
civerachb-cpr 206d9db
Add a deprecation notice to all Galactic tabs
civerachb-cpr 8d05b70
Add a full stop
civerachb-cpr 0eae41b
More full stops
civerachb-cpr 2433c2e
Use the styled warning box for the galactic deprecation notices
civerachb-cpr de65136
Add deprecation notice to the main galactic page
civerachb-cpr 5cedfec
Add more Jazzy sections
civerachb-cpr a7aed03
Add a note about the firmware being DDS-specific in Jazzy
civerachb-cpr bd40fc1
Move the deprecation notice below the title
civerachb-cpr 999884b
Update Jazzy changelog
civerachb-cpr 8dc2cca
Update jazzy package versions
civerachb-cpr 2a50448
Fix the Create3 firmware version
civerachb-cpr df1e667
Add a note about needing wireless equipment that provides 2.5 and 5 GHz
civerachb-cpr d6e94a9
Fix missing Jazzy section for discovery server
civerachb-cpr 1acca5c
Update discovery server & simple discovery instructions for Jazzy
civerachb-cpr fedff56
Add a note for Jazzy and Humble about NOT using the `_do_not_use` nam…
civerachb-cpr bd77900
Make sensor installation instructions generic with ROS_DISTRO envar, …
civerachb-cpr 3a835b9
Consolidate more sections, remove duplicate debian install instructio…
civerachb-cpr 7f562c5
More tab consolidations
civerachb-cpr 815e402
Add an additional note about choosing the correct RMW implementation …
civerachb-cpr 0b65650
Add a note to the bash setup table about RMW implementation needing t…
civerachb-cpr 16b9f29
Add a section for the Reset Create3 setup menu item
civerachb-cpr b1275ad
Add disable-diagnostics tab for jazzy
civerachb-cpr c1de5a4
Add sourcing-jazzy tab
civerachb-cpr be90253
Add tabs for the Create3 topics not being visible, rewrite that secti…
civerachb-cpr 6dd6174
Forgot to save before last commit
civerachb-cpr 63742f0
Consolidate keyboard teleop tabs by using envars
civerachb-cpr 8a75ff5
Add Jazzy sections to the first-node examples
civerachb-cpr 86c1e1a
Add jazzy slam
civerachb-cpr be6fba2
Add jazzy nav2
civerachb-cpr 28795fe
Add jazzy tabls for navigation, reword missing galactic tutorial notices
civerachb-cpr f11cd3f
Remove theme lines that are already in _config.yaml
civerachb-cpr ef63fdf
Remove command that's already in Makefile
civerachb-cpr 8fd28a0
Add `make update` to build commands
civerachb-cpr 25545a0
Update simple discovery networking for Jazzy
civerachb-cpr 1ed71bb
Remove superfluous line breaks
civerachb-cpr File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,8 +1,4 @@ | ||
remote_theme: false | ||
|
||
debug: | ||
compress: false | ||
dist: true | ||
shortcodes: true | ||
|
||
theme: jekyll-rtd-theme | ||
shortcodes: true |
This file contains 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
This file contains 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
This file contains 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
This file contains 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
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,83 @@ | ||
--- | ||
sort: 3 | ||
--- | ||
|
||
# TurtleBot 4 Jazzy | ||
|
||
TurtleBot 4 RPi4 image changelogs. Latest images are available [here](http://download.ros.org/downloads/turtlebot4/). | ||
|
||
## v2.0.0 | ||
|
||
**OS**: Ubuntu Server 24.04.5 LTS | ||
|
||
**ROS**: Jazzy | ||
|
||
**Create® 3 Firmware**: I.0.0 | ||
|
||
### General | ||
|
||
- Due to technical limitations, the Create3 firmware only supports FastRTPS or CycloneDDS; changing | ||
RMW implementations requires installing the correct firwmare version on the Create3 | ||
- Updated `install.py` to support Jazzy | ||
- Use `create3_republisher` by default to expose base platform topics from the RPi4 | ||
- ROS Control changes to use `TwistStamped` messages for velocity control instead of `Twist` | ||
- Renamed `ignition` and `ign` packages & launch files to use preferred `gz` nomenclature | ||
|
||
### TurtleBot 4 Packages | ||
|
||
<table> | ||
<thead> | ||
<tr> | ||
<th>Package</th> | ||
<th>Version</th> | ||
<th>Changes</th> | ||
</tr> | ||
</thead> | ||
<tbody> | ||
<tr> | ||
<td>turtlebot4_base</td> | ||
<td>2.0.0</td> | ||
<td>-</td> | ||
</tr> | ||
<tr> | ||
<td>turtlebot4_bringup</td> | ||
<td>2.0.0</td> | ||
<td>-</td> | ||
</tr> | ||
<tr> | ||
<td>turtlebot4_description</td> | ||
<td>2.0.0</td> | ||
<td>-</td> | ||
</tr> | ||
<tr> | ||
<td>turtlebot4_diagnostics</td> | ||
<td>2.0.0</td> | ||
<td>-</td> | ||
</tr> | ||
<tr> | ||
<td>turtlebot4_msgs</td> | ||
<td>2.0.0</td> | ||
<td>-</td> | ||
</tr> | ||
<tr> | ||
<td>turtlebot4_navigation</td> | ||
<td>2.0.0</td> | ||
<td>-</td> | ||
</tr> | ||
<tr> | ||
<td>turtlebot4_node</td> | ||
<td>2.0.0</td> | ||
<td>-</td> | ||
</tr> | ||
<tr> | ||
<td>turtlebot4_robot</td> | ||
<td>2.0.0</td> | ||
<td>-</td> | ||
</tr> | ||
<tr> | ||
<td>turtlebot4_tests</td> | ||
<td>2.0.0</td> | ||
<td>-</td> | ||
</tr> | ||
</tbody> | ||
</table> |
This file contains 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
Oops, something went wrong.
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.
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.
Can we add the update command into this process so it looks like:
This will ensure that the dependencies get updated, aligning with how the actual release will get built. (Otherwise the versions that you use locally stay locked to when you first built.) It is a future discussion to be had, (or you can look into) whether we can include the Gemfile.lock in the repo and whether that will be respected by Github Pages when it gets built, and not have to deal with the constant dependency updates.
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.
Done