ros2 / ros2_documentation

ROS 2 docs repository
https://docs.ros.org/en/rolling
Creative Commons Attribution 4.0 International
535 stars 1.06k forks source link

Add a documentation section to Contributing guides #596

Open maryaB-osr opened 4 years ago

maryaB-osr commented 4 years ago

This should be more of a content-and-structure advisory than rst tips or high level instructions like in the style guide and developer guide.

Include things like an empty tutorial layout in rst, title conventions, documentation-type definitions (once a distinction between tutorials/guides/concepts/demos is implemented), difficulty-level definitions, etc.

This can be a place where we accumulate non-technical standards for our documentation (use second person, when to use ` `, end file names with the file extension e.g. example.py, etc).

pxalcantara commented 3 years ago

Documentation is very important and also an "easy" way to contribute. How about adding the documentation (REAME) of this repository to the Contributing page in order to help beginners to improve ROS 2 documentation @clalancette? In this way, the documentation could improve faster and reduce the reluctance to migrate to ROS 2.

pxalcantara commented 3 years ago

Documentation is very important and also an "easy" way to contribute. How about adding the documentation (REAME) of this repository to the Contributing page in order to help beginners to improve ROS 2 documentation @clalancette? In this way, the documentation could improve faster and reduce the reluctance to migrate to ROS 2.

friendly ping @clalancette

clalancette commented 3 years ago

Documentation is very important and also an "easy" way to contribute. How about adding the documentation (REAME) of this repository to the Contributing page in order to help beginners to improve ROS 2 documentation @clalancette? In this way, the documentation could improve faster and reduce the reluctance to migrate to ROS 2.

Rather than copying this README to the Contributing page, I'd rather just link to it from there. That way we keep the technical information here in this repo, while still providing a way for people to find out how to contribute. What do you think?