From 151a170a47c0ce9f93ff7445f02aaea927e43553 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Steven!=20Ragnar=C3=B6k?= Date: Fri, 5 Nov 2021 13:50:55 -0700 Subject: [PATCH 1/2] Add ROS Support page. This is based on the page that used to be at https://www.ros.org/support I'm sure that there's more we can do but given how often this page is cited it would be nice to have something up there. --- content/support.md | 34 ++++++++++++++++++++++++++++++++++ 1 file changed, 34 insertions(+) create mode 100644 content/support.md diff --git a/content/support.md b/content/support.md new file mode 100644 index 0000000..e61bd8f --- /dev/null +++ b/content/support.md @@ -0,0 +1,34 @@ +--- +title: Support +layout: /general.* +--- + +# Support + +There are several mechanisms in place to provide support to the ROS community, each with its own purpose: the wiki, ROS Answers, issue trackers, and the ros-users@ mailing list. +It is important to pick the right resource to reduce response time, avoid message duplication, and promote the discussion of new ideas. + +## Wiki + +When something goes wrong, the [ROS wiki](https://wiki.ros.org) is your first stop. +In addition to the official documentation for ROS packages, the wiki contains two key resources you should consult: the Troubleshooting guide and the FAQ. +Solutions to many common problems are covered in these two pages. + +## ROS Answers + +If the wiki doesn't address your problem, [ROS Answers](https://answers.ros.org) is next. +Take heart: it is very likely that someone else has faced the same problem before, and that it's covered among the more than 10,000 questions at ROS Answers. +Start by searching for questions similar to yours; if your question isn't already asked, post a new one. +Be sure to check the guidelines on how to prepare your question before posting. + +## Issue trackers + +When you've identified a bug (e.g., as a result of a discussion at ROS Answers), or when you want to request a new feature, head to the issue trackers. +When reporting a bug, be sure to provide a detailed description of the problem, the environment in which it occurs, any detail that may help developers to reproduce the issue, and if possible, a debug backtrace. + +## ROS Discourse Forums + +To stay up-to-date on the latest developments within the ROS community, you'll want to join the [ROS Discourse](https://discourse.ros.org) forums. +These forums, are the place for announcements, news, and discussions of general interest. +The ROS Discourse is not the right place to ask troubleshooting questions or report bugs; please use the other support resources listed above instead. + From a9a48122974a6083a91fd84dda88f8f5165e6dba Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Steven!=20Ragnar=C3=B6k?= Date: Fri, 5 Nov 2021 15:16:15 -0700 Subject: [PATCH 2/2] Update with the support content from Getting Started. --- content/support.md | 37 ++++++++++++++++++++----------------- 1 file changed, 20 insertions(+), 17 deletions(-) diff --git a/content/support.md b/content/support.md index e61bd8f..68578f5 100644 --- a/content/support.md +++ b/content/support.md @@ -5,30 +5,33 @@ layout: /general.* # Support -There are several mechanisms in place to provide support to the ROS community, each with its own purpose: the wiki, ROS Answers, issue trackers, and the ros-users@ mailing list. +There are several mechanisms in place to provide support to the ROS community, each with its own purpose: [package documentation](https://docs.ros.org), [Q&A forum](https://answers.ros.org), [discussion forum](https://discourse.ros.org), [package index](https://index.ros.org), and of course the issue trackers. It is important to pick the right resource to reduce response time, avoid message duplication, and promote the discussion of new ideas. -## Wiki +## [ROS Package Documentation ](https://docs.ros.org) +Documentation for core ROS packages as well as package specific content is hosted on [docs.ros.org](https://docs.ros.org). +On this site you can find the core tutorials and documentation for the project as well as generated API documentation for individual packages. -When something goes wrong, the [ROS wiki](https://wiki.ros.org) is your first stop. -In addition to the official documentation for ROS packages, the wiki contains two key resources you should consult: the Troubleshooting guide and the FAQ. -Solutions to many common problems are covered in these two pages. +## [ROS Answers ](https://answers.ros.org) +If the documentation doesn't address your problem, [ROS Answers](https://answers.ros.org) is next. +Take heart: it is very likely that someone else has faced the same problem before, and that it's covered among the more than 10,000 questions at ROS Answers. +Start by searching for questions similar to yours; if your question isn't already asked, post a new one. Be sure to check the guidelines on how to prepare your question before posting. -## ROS Answers +## [ROS Discourse Forums ](https://discourse.ros.org) -If the wiki doesn't address your problem, [ROS Answers](https://answers.ros.org) is next. -Take heart: it is very likely that someone else has faced the same problem before, and that it's covered among the more than 10,000 questions at ROS Answers. -Start by searching for questions similar to yours; if your question isn't already asked, post a new one. -Be sure to check the guidelines on how to prepare your question before posting. +To stay up-to-date on the latest developments within the ROS community, you'll want to join the **[ROS Discourse](https://discourse.ros.org)** forums. +These forums are the place for announcements, news, and discussions of general interest. +The ROS Discourse is **not the right place to ask troubleshooting questions or report bugs**; please use the other support resources listed above instead. -## Issue trackers +## [ROS Index ](https://index.ros.org) -When you've identified a bug (e.g., as a result of a discussion at ROS Answers), or when you want to request a new feature, head to the issue trackers. -When reporting a bug, be sure to provide a detailed description of the problem, the environment in which it occurs, any detail that may help developers to reproduce the issue, and if possible, a debug backtrace. +When you want to find out information about a specific package the [index](https://index.ros.org) is the best place to start. +It connects you to all the important locations relevant to a package. +In addition to the official documentation for ROS packages, the wiki contains two key resources you should consult: the Troubleshooting guide and the FAQ. Solutions to many common problems are covered in these two pages. If you have ever used [PyPI](https://pypi.org/) you should feel right at home on ROS Index. -## ROS Discourse Forums +## [Issue Trackers ](https://github.com/ros2/ros2/issues) -To stay up-to-date on the latest developments within the ROS community, you'll want to join the [ROS Discourse](https://discourse.ros.org) forums. -These forums, are the place for announcements, news, and discussions of general interest. -The ROS Discourse is not the right place to ask troubleshooting questions or report bugs; please use the other support resources listed above instead. +When you've identified a bug (e.g., as a result of a discussion at [ROS Answers](https://answers.ros.org)), or when you want to request a new feature, head to the issue trackers. +Links are provided in the packages metadata available on [ROS Index](https://index.ros.org). +When reporting a bug, be sure to provide a detailed description of the problem, the environment in which it occurs, any detail that may help developers to reproduce the issue, and if possible, a debug backtrace.