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.

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

convert navigation2 tutorials to rst format for github pages #1428

Merged
merged 10 commits into from
Dec 12, 2019

Conversation

mlherd
Copy link
Contributor

@mlherd mlherd commented Dec 10, 2019

Manually converted the following tutorials to rst format.

  • Navigation2 on a Real Turtlebot 3
  • Navigation2 with Turtlebot 3 in Gazebo

Copied the doc images to sphinx_doc directory.

Changes in PR #1393 may affect this PR. (doc tree and links etc)

@mlherd mlherd self-assigned this Dec 10, 2019
Copy link
Member

@SteveMacenski SteveMacenski left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just some rewording, comment inline and we can discuss

Copy link
Contributor

@mhpanah mhpanah left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Personally I prefer not to use "I" , "you", "we" in technical documents. This document is written in a second person narrative with too many "you"s. I will approve, if that's okay with you.

@mlherd
Copy link
Contributor Author

mlherd commented Dec 11, 2019

Personally I prefer not to use "I" , "you", "we" in technical documents. This document is written in a second person narrative with too many "you"s. I will approve, if that's okay with you.

These are just tutorials, so I picked this language to give the user the feeling that "we" go through each step together. I didn't want this to sound like a boring product manual that no one ever reads :)

@codecov
Copy link

codecov bot commented Dec 11, 2019

Codecov Report

Merging #1428 into master will decrease coverage by 1.68%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master    #1428      +/-   ##
==========================================
- Coverage   40.28%   38.59%   -1.69%     
==========================================
  Files         229      229              
  Lines       11765    11765              
  Branches     5074     5074              
==========================================
- Hits         4739     4541     -198     
- Misses       3627     3872     +245     
+ Partials     3399     3352      -47
Flag Coverage Δ
#project 38.59% <ø> (-1.69%) ⬇️
Impacted Files Coverage Δ
...er/dwb_core/include/dwb_core/dwb_local_planner.hpp 0% <0%> (-100%) ⬇️
nav2_core/include/nav2_core/controller.hpp 50% <0%> (-50%) ⬇️
...controller/dwb_core/include/dwb_core/publisher.hpp 0% <0%> (-50%) ⬇️
...oller/include/nav2_controller/progress_checker.hpp 50% <0%> (-50%) ⬇️
...er/dwb_critics/include/dwb_critics/oscillation.hpp 33.33% <0%> (-33.34%) ⬇️
...ler/dwb_critics/include/dwb_critics/goal_align.hpp 66.66% <0%> (-33.34%) ⬇️
...ler/dwb_critics/include/dwb_critics/path_align.hpp 66.66% <0%> (-33.34%) ⬇️
...d/include/nav2_costmap_2d/costmap_2d_publisher.hpp 69.23% <0%> (-30.77%) ⬇️
nav2_recoveries/src/recovery_server.cpp 15.06% <0%> (-23.29%) ⬇️
nav2_waypoint_follower/src/waypoint_follower.cpp 11.86% <0%> (-21.19%) ⬇️
... and 33 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 3c736f8...580a419. Read the comment docs.

@SteveMacenski
Copy link
Member

I think the only thing left from my review is the turtlebot links

@mlherd mlherd merged commit c6d98d9 into ros-navigation:master Dec 12, 2019
crdelsey pushed a commit that referenced this pull request Dec 13, 2019
Converted the following tutorials to rst format.

- Navigation2 on a Real Turtlebot 3
- Navigation2 with Turtlebot 3 in Gazebo
- Copied the documentation images to sphinx_doc directory.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants