Reorg and Ros2 Humble #128
Merged
Conversation
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
Initial ROS 2 content
Minor fixes
Added PS4 controller image
Added supported sensors list
Formatting fixes
…ich sensors are currently included for ROS 2
…file to be included elsewhere and it won't be given its own page on the website
hilary-luo
requested review from
rhysfaultless-cpr and
tonybaltovski
as code owners
|
LGTM |
jhiggins-cpr
reviewed
Jul 7, 2023
jhiggins-cpr
approved these changes
Jul 7, 2023
Clearpath Config Skeleton Documentation
Networking documentation
|
@hilary-luo please squash-and-merge this one when you are ready. |
hilary-luo
added a commit
that referenced
this pull request
Aug 3, 2023
* Changed the tabs and restructured the files to reflect that * Added versioning to the robot / ROS section of the website * Added dropdowns to manage versioning * Correcting sidebar order * Reduced how much information is displayed in the sidebar * Added ROS 2 Humble Documentation --------- Co-authored-by: Roni Kreinin <rkreinin@clearpathrobotics.com> Co-authored-by: Tony Baltovski <tbaltovski@clearpathrobotics.com> Co-authored-by: Luis Camero <lcamero@clearpathrobotics.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
6 participants
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.
This is a major change to the structure of how to access information on the website and how the non-nav data is managed.
The major changes are as follows:
Reducing the number of tabs at the top by combining all robot accessories into one entry under robots (includes manipulators, computers, sensors etc). Renaming Software to ROS to better reflect the contents. Both of these changes better reflect the layout of our marketing website.
Removing the tools tab and redistributing the information
Moving OutdoorNav and IndoorNav to the navbar to make them easy to find and give emphasis as products
Added versioning drop downs, 1 for robots + ROS and 1 for outdoorNav. These are responsive in that they only show up when you are browsing that section of the website. These default to the latest version the first time you access them and automatically update for new versions. OutdoorNav also has a legacy version listed which takes you to a page with links to the old documentation.
Left side bar only shows the relevant information for the tab that you are browsing.
Robot & ROS sections are versioned by ROS version (currently ROS 1 Noetic or ROS 2 Humble). Thus, ROS 2 information has been removed from the ROS 1 version and vice versa
Filling the ROS 2 ROS tab with documentation for the humble software release
Relevant notes:
Some images and components are being versioned within the docs folders while images and components that are common across ROS 1 and ROS 2 documentation are still in the static and components folders respectively. In the future as we update hardware pages we could convert more of that into common components to prevent having to maintain mutliple copies of the same information.
Links had to all be changed to relative links in order for the versioning to work properly (shortcuts were taken in the ROS 1 version for obsolete components - not deemed worth the effort to turn into relative links)
"Next" version is now being hidden and has to be enabled if we want to use it for development.
Readme was updated to reflect the new processes