diff --git a/about.md b/about.md index 50371b4d..64ed809d 100644 --- a/about.md +++ b/about.md @@ -22,6 +22,7 @@ For more information see: * [Design]({{ "/about/design" | prepend: site.baseurl }}) * [Development]({{ "/about/development" | prepend: site.baseurl }}) +* [Tutorial]({{ "/about/tutorial" | prepend: site.baseurl }}) See [rosindex on GitHub](https://github.com/ros-infrastructure/rosindex) for active development. diff --git a/about/tutorial.md b/about/tutorial.md new file mode 100644 index 00000000..3957a8b8 --- /dev/null +++ b/about/tutorial.md @@ -0,0 +1,32 @@ +This guide introduces the standard way of searching for ROS 2 package-level documentation. +There are thousands of ROS packages that encompass all aspects of robotics; everything from hardware drivers to high-level planning and navigation. +Some of these packages exist solely as open source code, while others are distributed as binary packages that can be easily installed on a ROS system using tools like `apt`. +This tool - ROS Index - __, is similar to `Python's Package Index (PyPI) `__. +A good way to find a solution to many common robotics problems is to use ROS Index to find an appropriate ROS 2 binary package from the ROS ecosystem. +Using ROS Index you can find binary ROS packages, the source code behind them, and their associated documentation and tutorials. + + +Searching for ROS Packages +---------------------------- + +Locate the search bar in the middle of the screen on `index.ros.org `__: + + + +You can use this search bar to find specific packages or search for specific package features. +ROS Index has the capability to search through the available package documentation and find keywords that match the given search query. + +For example if one wanted to do color processing on images they could either search `image_proc` or `image processing`. +After clicking the top package in the list, it will bring one to a page similar to `this `_: + + + +Breaking it Down +~~~~~~~~~~~~~~~~ + +1. `Package Description` The general description of the package, this should be similar to what was searched if it wasn't an exact package name. +2. `Tutorials` If there are any tutorials available in the documentation they will show up here. Those looking to get started with a package should look here as the tutorials will often be up to date and well maintained by those who use the package often. +3. `Documentation` The original documentation for the ROS package and the repository where source code and documentation can be found.``` +4. `Distribution` ROS 2 has `various distributions `_ which may have differences in design. Click on the ROS distribution (version) that matches the ROS version installed on your system. +5. `Contributing` This software is open source, so it needs the community's help to actively be maintained. One should utilize this section if they wish to help solve issues, review pull requests, or are looking to see if an active fix is being deployed for a problem they encountered. +6. `Maintainers` This tab lists the community members who are actively responsible for the development of the package. While the maintainers have a vast amount of information one should use the `Robotics Stack Exchange `_ with the [tag] of the package, if they want questions answered. diff --git a/assets/package_info.png b/assets/package_info.png new file mode 100644 index 00000000..ca5afd0c Binary files /dev/null and b/assets/package_info.png differ diff --git a/assets/search_bar.png b/assets/search_bar.png new file mode 100644 index 00000000..84d70200 Binary files /dev/null and b/assets/search_bar.png differ diff --git a/index.html b/index.html index 76d626d2..2ffe1ebe 100644 --- a/index.html +++ b/index.html @@ -49,6 +49,11 @@

Welcome to ROS Index

You can enter keywords and phrases in the search bar and then filter results by resource type, or you can browse the complete package, repository and system dependency lists under the Index tab.

+

+ New to ROS Index? Be sure to follow our + Tutorial + To learn more about the process of searching for packages +