GSoD_exploration
This document describes a list of potential ideas created for the 2023 Google Season of Docs. However, the ideas are open to everyone with interest on collaborating, and Open Robotics is open to new ideas. If you would like to suggest new projects please message gsod AT osrfoundation.org.
The following list shows a set of ideas that can extend the documentation of the Gazebo open source project led by OSRF.
Gazebo is a suite of tools, libraries, and cloud services designed to iterate quickly on design concepts and robot control strategies. Gazebo Sim. a leading robotics simulator, plays a central role by providing a robust and proven environment in which to create and test autonomous platforms.
Gazebo Sim has a long history spanning over 17 years, from its humble origins as a research tool to it widespread use in industry and government institutions. Over this time Gazebo Sim has proven itself in various virtual competitions, city and vehicle simulation, and aerial vehicle simulation.
The link between all the Gazebo components is their open source nature and its relationship with robotics. Browse through the list and do not hesitate to contact us if you wish to participate in any of the projects. Share with us your thoughts and ideas on any future improvement or project you may have.
- List of prerequisites: Linux, git
- Description of programming skills: C++ and python
- Difficulty level: Medium
- List of potential mentors: Alejandro Hernández
- Detailed description: Users learning about Gz Math should be able to refer to simple examples to learn how to use the APIs. We should have examples in C++, as well as any scripting languages that we support (currently Ruby and Python). This task may include support Ruby interfaces. Related issues 1 and 2
For a general introduction on how to start contributing to Gazebo, check out the documentation! If you have any technical questions feel free to ask them at Gazebo Answers or message @HelloWorld at Gazebo Community.
- List of prerequisites: Linux, git
- Description of programming skills: C++ and python
- Difficulty level: Medium
- List of potential mentors: Carlos Agüero
- Detailed description: The next Gazebo release will occur in September 2023. The goal is to produce, edit and improve all the associated documentation to this release.
For a general introduction on how to start contributing to Gazebo, check out the documentation! If you have any technical questions feel free to ask them at Gazebo Answers or message @HelloWorld at Gazebo Community.
- List of prerequisites: Linux, git, ROS
- Description of programming skills: C++ and python
- Difficulty level: Medium
- List of potential mentors: Chris Lalancette and Katherine Scott
- Detailed description: Robot Operating System (ROS) is currently in the process of transitioning from its first major version, ROS 1, to its second major version ROS 2. This transition process started in earnest in 2017 and should be completed by 2025. As part of the early development of ROS 2 we created a series of community design documents. These design documents were used to drive community discussion and educate the broader ROS community about the ROS 2 effort. As ROS 2 has matured the bulk of our documentation efforts have moved to developing the ROS 2 documentation. As such, the ROS 2 design documents have languished and become partially out dated. The design documents have also become a point of confusion for the broader ROS community, and current ROS 2 implementations may differ substantially from the original design documents. However, many of these design documents still contain information that remains relevant to the ROS community. The ROS team has made the decision to update these documents and move them into the existing ROS documentation. We are seeking a GSoD student to assist us with transitioning content from these design documents into the more widely used ROS 2 documentation.
GSoD students interested in working on this project will work closely with their mentors to develop a plan to transition the ROS 2 design documents to the ROS 2 documentation. A normal week of work will involve meeting with the mentor twice a week to select specific design documents to transition. The mentor will work with the student to outline the necessary changes to the design documents and where the updated document belongs in the broader ROS 2 documentation information architecture. A good student candidate should be familiar with the Github pull request workflow, Markdown and Restructured Text syntax, and elementary HTML syntax. Students should have a strong command of the English language and a clear and concise writing style.
- List of prerequisites: Linux, git, ROS, Ignition
- Description of programming skills: C++ and python
- Difficulty level: Medium
- List of potential mentors: Alejandro Hernández
- Detailed description: We should create introductory tutorials, New ROS 2 developers can easily launch and tweak a full robot development environment even if they don't have a physical robot. Related issue.
ROS 2 is the next generation of the successful ROS project for enabling rapid development and deployment of robots in many fields. Like ROS before it, ROS 2 serves a wide range of robotics applications and the field moves rapidly. The project below are some ideas that would improve the ROS 2 documentation both for beginners and for more experienced users.