Skip to content
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
wants to merge 44 commits into
base: gh-pages
Choose a base branch
from
Open

Add Jazzy documentation #26

wants to merge 44 commits into from

Conversation

civerachb-cpr
Copy link

Description

  • Add jazzy tabs where relevant
  • Add deprecation notices to all Galactic pages & tabs indicating that it is no longer supported

Copy link
Contributor

@hilary-luo hilary-luo left a comment

Choose a reason for hiding this comment

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

Overall the changes look good but there seems to be some sections that need Jazzy specific attention.

```bash
wget https://raw.githubusercontent.com/turtlebot/turtlebot4_setup/humble/scripts/sd_flash.sh
wget https://raw.githubusercontent.com/turtlebot/turtlebot4_setup/jazzy/scripts/sd_flash.sh
Copy link
Contributor

Choose a reason for hiding this comment

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

Has this file changed in anyway that would affect it's usability in Humble?

Copy link
Author

Choose a reason for hiding this comment

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

The Jazzy version adds

for device in $device_names
do
    if [[ $device == mmcblk* ]]; then
        last_partition="${device}p2"
    else
        last_partition="${device}2"
    fi

    sudo growpart /dev/$device 2
    sudo resize2fs /dev/${last_partition}
done

to the end of the script to automatically expand the writable partition to the maximum space of the SD card. I haven't tested the Jazzy script with Humble images, so I'm not sure if the change is backwards-compatible. But using the Jazzy version of the script with the Jazzy images is recommended.

setup/discovery_server.md Outdated Show resolved Hide resolved
Copy link
Contributor

Choose a reason for hiding this comment

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

This file needs to be updated for the usage of the republisher. (Ensuring that the create3 is disconnected from WiFi and linking to the description of the republisher - like in discovery server.)

Copy link
Author

Choose a reason for hiding this comment

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

Took a first pass at the rewrites. I moved the wifi & application config into new tabs and added a new screenshot for Jazzy.


By default, the Turtlebot 4 uses the `create3_republisher` node to isolate the Create® 3 from the remainder of the ROS 2 network traffic. This helps limit the network traffic that reaches the Create® 3 when it is connected to the wireless network, especially when multiple robots are connected. All ROS 2 traffic is routed via the Turtlebot 4's Raspberry Pi computer, and the `create3_republisher` node exposes the Create® 3's topics, services, and actions the robot's main namespace. This allows external workstations and other robots to interact with the robot via the Raspberry Pi's wireless connection.

The Create® 3's topics, services, and actions are all available inside a namespace called `_do_not_use`. This results in the topics being hidden, and clearly indicates that they should not be used directly by the user. The Create® 3 only communicates with the single Raspberry Pi that is present on the same robot. All of the Create® 3 topics, actions and services are then republished and relayed by the Raspberry Pi `create3_republisher` node with just the robot namespace so they are fully visible and available to the rest of the ROS 2 network. In order to interact with the Create® 3, any given node will interact with the topics, actions, and servers generated by the Raspberry Pi, and the republisher node on the Raspberry Pi will relay that information back to the Create® 3.
Copy link
Contributor

Choose a reason for hiding this comment

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

Can we clarify (for both Jazzy and Humble) that the _do_not_use namespace should not be used anywhere outside of the create3 webserver. The only place where that namespace needs to be used directly is when setting the "Application ROS 2 Parameters File" within the create3 webserver.

Copy link
Author

Choose a reason for hiding this comment

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

Added a note to Humble and Jazzy about this.

software/sensors.md Outdated Show resolved Hide resolved
.debug.yml Outdated
@@ -1,8 +1,8 @@
remote_theme: false
remote_theme: clearpathrobotics/jekyll-rtd-theme
Copy link
Contributor

Choose a reason for hiding this comment

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

The debug file overrides the _config.yml so if we want debug to perform the same as the release then we should remove both lines (remote_theme and theme) rather than duplicating what is present in the _config.yml file.

Copy link
Author

Choose a reason for hiding this comment

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

Done

README.md Outdated
Next [install Jekyll and the rest of the prerequisites](https://jekyllrb.com/docs/). Be careful to not overwrite the Ruby version.
Next [install Jekyll and the rest of the prerequisites](https://jekyllrb.com/docs/). Be careful to not overwrite the Ruby version.
```shell
gem install jekyll bundler
Copy link
Contributor

Choose a reason for hiding this comment

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

This is unnecessary because it is run as part of the make command.

Copy link
Author

Choose a reason for hiding this comment

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

Done

@@ -48,4 +51,4 @@ make
make server
Copy link
Contributor

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:

make
make update
make server

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.

Copy link
Author

Choose a reason for hiding this comment

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

Done

Copy link
Contributor

Choose a reason for hiding this comment

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

This needs to update for the Create3 no longer needing to be connected to wifi and should contain a brief description that the create3 info is routed through the pi. Additionally the 2.4 GHz network is no longer required at all and does not need to be bridged.

Copy link
Author

Choose a reason for hiding this comment

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

Done

setup/basic.md Outdated
If you are moving your TurtleBot 4 to a new location with a different Wi-Fi network,
reconfigure the Raspberry Pi to connect to that network beforehand or place it into AP mode.
If you are moving your TurtleBot 4 to a new location with a different Wi-Fi network,
reconfigure the Raspberry Pi to connect to that network beforehand or place it into AP mode.
Copy link
Contributor

Choose a reason for hiding this comment

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

The trailing spaces in this section are functional. When it gets built, the single newline is removed and no additional space is added. Can we either leave the trailing space or remove the unnecessary newlines. I have only made this comment here but there are a number of pages with this same issue. (Including this file, discovery_server.md, simple_discovery.md, diagnostics.md, multiple_robots.md). This only affects paragraphs that are interrupted by single newlines (double newline indicating the start of a new paragraph).

Copy link
Author

Choose a reason for hiding this comment

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

Do we want to force newlines like that though? For adaptive screen sizes or users with accessibility issues (e.g. larger-than-default fonts) it seems better to just let the default line-wrapping do its thing, rather than manually inserting line breaks that may not always align correctly.

Copy link
Author

Choose a reason for hiding this comment

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

Some of the trailing spaces removed were already at the ends of paragraphs or were independent list items, so I've left those alone. The rest I've removed the superfluous line breaks from the source.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants