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.

Sign up for GitHub

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 ROS Support page. #23

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Add ROS Support page. #23

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
151a170
Add ROS Support page.
nuclearsandwich Nov 5, 2021
a9a4812
Update with the support content from Getting Started.
nuclearsandwich Nov 5, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 37 additions & 0 deletions content/support.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
---
title: Support
layout: /general.*
---

# Support

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.

## [ROS Package Documentation <i style="font-size: 1rem;" class="fas fa-file-code"></i>](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.

## [ROS Answers <i style="font-size: 1rem;" class="fas fa-question-circle"></i>](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 Discourse Forums <i style="font-size: 1rem;" class="fas fa-comments"></i>](https://discourse.ros.org)

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.

## [ROS Index <i style="font-size: 1rem;" class="fas fa-sitemap"></i>](https://index.ros.org)

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.

## [Issue Trackers <i style="font-size: 1rem;" class="fas fa-bug"></i>](https://github.com/ros2/ros2/issues)

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.