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

Jump to bottom

New tutorial for creating a workspace #359

Merged
merged 11 commits into from
Oct 24, 2019
Merged

New tutorial for creating a workspace #359

merged 11 commits into from
Oct 24, 2019

Conversation

maryaB-osr
Copy link
Contributor

Signed-off-by: maryaB-osr [email protected]

@maryaB-osr maryaB-osr requested a review from tfoote October 15, 2019 20:27
@wuffle-ros wuffle-ros bot added the in review label Oct 15, 2019
@mjcarroll mjcarroll temporarily deployed to ros2-documentation-pr-359 October 15, 2019 20:27 Inactive
@maryaB-osr
typo
1b8ae19 
Signed-off-by: maryaB-osr <[email protected]>
@mjcarroll mjcarroll temporarily deployed to ros2-documentation-pr-359 October 15, 2019 20:36 Inactive
dirk-thomas
dirk-thomas reviewed Oct 16, 2019
View reviewed changes
source/Tutorials/Workspace/CreatingAWorkspace.rst

.. code-block:: bash

. ~/ros2_install/ros2-osx/setup.bash
Copy link
Member

Choose a reason for hiding this comment

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

We wanted to make sure to embed the distro name into the directory for macOS / Windows too, right?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Does this do it #380 ?

source/Tutorials/Workspace/CreatingAWorkspace.rst

cd dev_ws

In the root, source your overlay:
Copy link
Member

Choose a reason for hiding this comment

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

If the user has already sourced the underlay they only need to source the local_setup file of the overlay.

Or they just source the setup file of the overlay which implicitly will source the underlay.

Copy link
Contributor

Choose a reason for hiding this comment

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

Actually, an explanation of the difference between setup.bash and local_setup.bash would probably be good here. It's a question I get a lot.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Adding this note:

.. note::

  Sourcing the ``local_setup`` of the overlay will only add the packages available in the overlay to your environment.
  ``setup`` sources the overlay as well as the underlay it was created in, allowing you to utilize both workspaces.

  So, sourcing your main ROS 2 installation's ``setup`` and then the ``dev_ws`` overlay's ``local_setup``, like you just did,
  is the same as just sourcing ``dev_ws``'s ``setup``, because that includes the environment of the underlay it was created in.

Does that make sense?

clalancette
clalancette requested changes Oct 16, 2019
View reviewed changes
source/Tutorials/Workspace/CreatingAWorkspace.rst

.. code-block:: bash

sudo rosdep install -i --from-path src --rosdistro <distro> -y
Copy link
Contributor

Choose a reason for hiding this comment

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

Do we have a tutorial that talks about rosdep? Otherwise, this is kind of magical. If we do have a tutorial talking about rosdep, we should probably have some language saying that you'll learn about it later.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Hmm.. there is a bit more about dependencies once they start creating their own packages, but not much more about rosdep specifically. I'll say "later" for now and make a note to add more in-depth notes about rosdep. I also think the opening and closing lines of this section provide a sufficient temporary introduction, albeit very vague

Copy link
Contributor

Choose a reason for hiding this comment

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

I'm fine with punting on rosdep for now. I've opened #381 to track adding a tutorial about rosdep.

source/Tutorials/Workspace/CreatingAWorkspace.rst

cd dev_ws

In the root, source your overlay:
Copy link
Contributor

Choose a reason for hiding this comment

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

Actually, an explanation of the difference between setup.bash and local_setup.bash would probably be good here. It's a question I get a lot.

@maryaB-osr @clalancette
typo
7971e0f 
Co-Authored-By: Chris Lalancette <[email protected]>
@mjcarroll mjcarroll temporarily deployed to ros2-documentation-pr-359 October 16, 2019 18:58 Inactive
@clalancette clalancette mentioned this pull request Oct 24, 2019
Closed
@mjcarroll mjcarroll temporarily deployed to ros2-documentation-pr-359 October 24, 2019 16:48 Inactive
@mjcarroll mjcarroll temporarily deployed to ros2-documentation-pr-359 October 24, 2019 16:54 Inactive
@mjcarroll mjcarroll temporarily deployed to ros2-documentation-pr-359 October 24, 2019 17:02 Inactive
tfoote
tfoote approved these changes Oct 24, 2019
View reviewed changes
Copy link
Contributor

@tfoote tfoote left a comment •
edited
Loading

Choose a reason for hiding this comment

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

I had a few more suggestions but otherwise it looks good to me.

For quick reference the tutorial can be reviewed at: https://ros2-documentation-pr-359.herokuapp.com/Tutorials/Workspace/CreatingAWorkspace.html

clalancette
clalancette reviewed Oct 24, 2019
View reviewed changes
Copy link
Contributor

@clalancette clalancette left a comment

Choose a reason for hiding this comment

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

I've got a few more nits to fix.

@mjcarroll mjcarroll temporarily deployed to ros2-documentation-pr-359 October 24, 2019 18:55 Inactive
@maryaB-osr @tfoote
main source not mandatory
d2f7cd9 
Co-Authored-By: Tully Foote <[email protected]>
@mjcarroll mjcarroll temporarily deployed to ros2-documentation-pr-359 October 24, 2019 18:56 Inactive
@mjcarroll mjcarroll temporarily deployed to ros2-documentation-pr-359 October 24, 2019 18:59 Inactive
@mjcarroll mjcarroll temporarily deployed to ros2-documentation-pr-359 October 24, 2019 21:00 Inactive
clalancette
clalancette approved these changes Oct 24, 2019
View reviewed changes
Copy link
Contributor

@clalancette clalancette left a comment

Choose a reason for hiding this comment

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

This looks good to me, but you'll want to fix the failing CI before merging.

@maryaB-osr
trailing whitespace
82f9782 
Signed-off-by: maryaB-osr <[email protected]>
@maryaB-osr maryaB-osr merged commit 0957642 into staging Oct 24, 2019
@wuffle-ros wuffle-ros bot removed the in review label Oct 24, 2019
@delete-merged-branch delete-merged-branch bot deleted the tutorial11 branch October 24, 2019 21:24
maryaB-osr added a commit that referenced this pull request Oct 25, 2019
@maryaB-osr
Complete tutorials set (#386)
d313ba7 
* Environment config tutorial (#334)

* Environment config tutorial

Signed-off-by: maryaB-osr <[email protected]>

* Added pages to some empty links for CI check

Signed-off-by: maryaB-osr <[email protected]>

* Add requirements.txt and app.json for Heroku build (#336)

This enables heroku "review apps"

Signed-off-by: Michael Carroll <[email protected]>

* Addressed reviews and implemented tabs

Signed-off-by: maryaB-osr <[email protected]>

* Added tabs install instructions for travis

Signed-off-by: maryaB-osr <[email protected]>

* Fixed Travis warnings

Signed-off-by: maryaB-osr <[email protected]>

* Prereqs note about using debs. for linux

Signed-off-by: maryaB-osr <[email protected]>

* Added reference for linking

Signed-off-by: maryaB-osr <[email protected]>

* Update Goal statement

Co-Authored-By: Jacob Perron <[email protected]>

* Remove leading arrowhead from Windows command

Co-Authored-By: Jacob Perron <[email protected]>

* Empty line before .. todo:

Co-Authored-By: Jacob Perron <[email protected]>

* "value" to "integer" for ROS_DOMAIN_ID

Co-Authored-By: Jacob Perron <[email protected]>

* Added ROS_DOMAIN_ID explanation

Signed-off-by: maryaB-osr <[email protected]>

* Link to ROS Answers

Also left a note to test Windows domain ID command

Signed-off-by: maryaB-osr <[email protected]>

* Syntax error on ROS answers link

Signed-off-by: maryaB-osr <[email protected]>

* Changed domainID tabs to include script command

Signed-off-by: maryaB-osr <[email protected]>

* Fixed too much indentation

Signed-off-by: maryaB-osr <[email protected]>

* Update Windows ROS_DOMAIN_ID config section (#341)

* Update Windows ROS_DOMAIN_ID config section

Signed-off-by: Jacob Perron <[email protected]>

* Update source/Tutorials/ConfiguringROS2Environment.rst

Co-Authored-By: Chris Lalancette <[email protected]>

* New tutorial for introducing turtlesim for ROS 2 (#342)

* New tutorial for introducing turtlesim for ROS 2

Signed-off-by: maryaB-osr <[email protected]>

* Trying one image

Signed-off-by: maryaB-osr <[email protected]>

* New file not included in toctree

Signed-off-by: maryaB-osr <[email protected]>

* All images and fix toctree (?)

Signed-off-by: maryaB-osr <[email protected]>

* More concise goal statement

Co-Authored-By: Chris Lalancette <[email protected]>

* Update Windows ROS_DOMAIN_ID config section (#341)

* Update Windows ROS_DOMAIN_ID config section

Signed-off-by: Jacob Perron <[email protected]>

* Update source/Tutorials/ConfiguringROS2Environment.rst

Co-Authored-By: Chris Lalancette <[email protected]>

* Removed ros2 run explanation (for next tutorial)

Signed-off-by: maryaB-osr <[email protected]>

* "turtled" to "turtle"

Co-Authored-By: Chris Lalancette <[email protected]>

* clalancette's requested changes

Signed-off-by: maryaB-osr <[email protected]>

* dirk-thomas's requested changes

Signed-off-by: maryaB-osr <[email protected]>

* forgot to remove "2" from file name

Signed-off-by: maryaB-osr <[email protected]>

* fixed backticks and added sentence about pen

Signed-off-by: maryaB-osr <[email protected]>

* corrections from dirk-thomas

Signed-off-by: maryaB-osr <[email protected]>

* New tutorial on ROS 2 topics (#344)

* New tutorial on ROS 2 topics

Signed-off-by: maryaB-osr <[email protected]>

* removed random ?

Signed-off-by: maryaB-osr <[email protected]>

* comment out empty reference

Signed-off-by: maryaB-osr <[email protected]>

* remove "on"

Co-Authored-By: Chris Lalancette <[email protected]>

* clarify topics definition

Co-Authored-By: Chris Lalancette <[email protected]>

* "process" > "topic"

Co-Authored-By: Chris Lalancette <[email protected]>

* reword "command line introspection"

Co-Authored-By: William Woodall <[email protected]>

* properly name topics and nodes

Co-Authored-By: William Woodall <[email protected]>

* clarify not all robots need a data stream

Co-Authored-By: William Woodall <[email protected]>

* typo "you" > "your"

Co-Authored-By: William Woodall <[email protected]>

* address comments on definition of topics

Signed-off-by: maryaB-osr <[email protected]>

* Rearrange background info

Signed-off-by: maryaB-osr <[email protected]>

* typo

Co-Authored-By: Chris Lalancette <[email protected]>

* minor edits

Signed-off-by: maryaB-osr <[email protected]>

* New tutorial on ROS 2 services (#346)

* New tutorial on ROS 2 services

Signed-off-by: maryaB-osr <[email protected]>

* adding links on turtlesim, config, topics

Signed-off-by: maryaB-osr <[email protected]>

* removed cluttered parameter services

Signed-off-by: maryaB-osr <[email protected]>

* YAML syntax only on cmd line

Co-Authored-By: Chris Lalancette <[email protected]>

* specified synchronous services will wait

Signed-off-by: maryaB-osr <[email protected]>

* single quotes inside double quotes

Co-Authored-By: Scott K Logan <[email protected]>

* addressed cottsay's reviews

Signed-off-by: maryaB-osr <[email protected]>

* more intuitive topics/services description

Signed-off-by: maryaB-osr <[email protected]>

* more concise wording

Co-Authored-By: Chris Lalancette <[email protected]>

* missing comma

Co-Authored-By: Chris Lalancette <[email protected]>

* typo

Signed-off-by: maryaB-osr <[email protected]>

* New tutorial for ROS 2 parameters (#347)

* New tutorial for ROS 2 parameters

Signed-off-by: maryaB-osr <[email protected]>

* Forgot toctree and goal statement

Signed-off-by: maryaB-osr <[email protected]>

* italics > bold

Signed-off-by: maryaB-osr <[email protected]>

* small edits based on reviews

Signed-off-by: maryaB-osr <[email protected]>

* Change the main README to say to use pip for sphinx and required sphinx-tab installation. (#363)

Add sphinx and sphinx-tab into requirements.txt

Clarify to use pip3 so people implicitly know that python3 is required

Further clarify sphinx requirements

* New tutorial for ROS 2 nodes (#343)

* New tutorial for ROS 2 nodes

Signed-off-by: maryaB-osr <[email protected]>

* commented out empty reference (for now)

Also added link target to concept overview page

Signed-off-by: maryaB-osr <[email protected]>

* removed pic link, added code blocks

Signed-off-by: maryaB-osr <[email protected]>

* "Hopefully" sounds silly

Co-Authored-By: Chris Lalancette <[email protected]>

* "multiple nodes" to "one or more"

Co-Authored-By: Chris Lalancette <[email protected]>

* added node info with actions

Signed-off-by: maryaB-osr <[email protected]>

* added links for prereqs and next steps

Signed-off-by: maryaB-osr <[email protected]>

* fixed node def & added design doc link

Signed-off-by: maryaB-osr <[email protected]>

* New tutorial for ROS 2 actions (#350)

* New tutorial for ROS 2 actions

Signed-off-by: maryaB-osr <[email protected]>

* travis warning

Signed-off-by: maryaB-osr <[email protected]>

* explicitly describe action goal process

Co-Authored-By: Jacob Perron <[email protected]>

* correct services definition

Co-Authored-By: Jacob Perron <[email protected]>

* correct implemenation details

Co-Authored-By: Jacob Perron <[email protected]>

* cancel > preempt

Co-Authored-By: Jacob Perron <[email protected]>

* minor updates

Signed-off-by: maryaB-osr <[email protected]>

* jacobperron's review

Signed-off-by: maryaB-osr <[email protected]>

* Changed `action show` to `interface show`

Signed-off-by: maryaB-osr <[email protected]>

* updated hidden actions in node info & removed bash

Signed-off-by: maryaB-osr <[email protected]>

* New tutorial for ROS 2 rqt_console (#351)

* New tutorial for ROS 2 rqt_console

Signed-off-by: maryaB-osr <[email protected]>

* missing spaces in topic pub yaml

Co-Authored-By: Michel Hidalgo <[email protected]>

* change tense

Co-Authored-By: Michel Hidalgo <[email protected]>

* first > top

Co-Authored-By: Chris Lalancette <[email protected]>

* specify new terminal

Co-Authored-By: Chris Lalancette <[email protected]>

* change file names and add links to prereqs

Signed-off-by: maryaB-osr <[email protected]>

* minor changes from reviews

Signed-off-by: maryaB-osr <[email protected]>

* addressed reviews

Signed-off-by: maryaB-osr <[email protected]>

* typo + updated remapping syntax

Signed-off-by: maryaB-osr <[email protected]>

* Updated remapping syntax (#354)

* Updated remapping syntax

Signed-off-by: maryaB-osr <[email protected]>

* tabs for eloquent/dashing remap syntax

Signed-off-by: maryaB-osr <[email protected]>

* New tutorial for ROS 2 bag files (#355)

* New tutorial for ROS 2 bag files

Signed-off-by: maryaB-osr <[email protected]>

* trying to make alt-text for internal links work

Signed-off-by: maryaB-osr <[email protected]>

* added available links

Signed-off-by: maryaB-osr <[email protected]>

* addressed reviews

Signed-off-by: maryaB-osr <[email protected]>

* New tutorial for creating a workspace (#359)

* New tutorial for creating a workspace

Signed-off-by: maryaB-osr <[email protected]>

* typo

Signed-off-by: maryaB-osr <[email protected]>

* typo

Co-Authored-By: Chris Lalancette <[email protected]>

* addressed reviews (dirk-thomas & clalancette)

Signed-off-by: maryaB-osr <[email protected]>

* revert source paths until PR 380 merges

Signed-off-by: maryaB-osr <[email protected]>

* underlay != main installation

Co-Authored-By: Tully Foote <[email protected]>

* main source not mandatory

Co-Authored-By: Tully Foote <[email protected]>

* underlay != main installation (again)

Co-Authored-By: Tully Foote <[email protected]>

* tfoote and clalancette suggestions

Signed-off-by: maryaB-osr <[email protected]>

* trailing whitespace

Signed-off-by: maryaB-osr <[email protected]>

* New tutorial for creating a package in ROS 2 (#362)

* New tutorial for creating a package in ROS 2

Signed-off-by: maryaB-osr <[email protected]>

* addressed review from ivanpauno & sloretz

Signed-off-by: maryaB-osr <[email protected]>

* ivan's final review

Signed-off-by: maryaB-osr <[email protected]>

* New tutorial for ros2doctor (#378)

* New tutorial for ros2doctor

Signed-off-by: maryaB-osr <[email protected]>

* linter

Signed-off-by: maryaB-osr <[email protected]>

* claireyywang's review

Signed-off-by: maryaB-osr <[email protected]>

* New tutorial for service and client using C++ (#370)

* new tutorial for service and client using C++

Signed-off-by: maryaB-osr <[email protected]>

* linter fix

Signed-off-by: maryaB-osr <[email protected]>

* linter

Signed-off-by: maryaB-osr <[email protected]>

* forgot package name in pkg create

Signed-off-by: maryaB-osr <[email protected]>

* improve sentence structure

Co-Authored-By: Michel Hidalgo <[email protected]>

* minor changes

Signed-off-by: maryaB-osr <[email protected]>

* target > targets

* Update parameters tutorial (#384)

* Update parameters tutorial

Signed-off-by: maryaB-osr <[email protected]>

* linter

Signed-off-by: maryaB-osr <[email protected]>

* New tutorial for Python pub/sub (#364)

* New tutorial for Python pub/sub

Signed-off-by: maryaB-osr <[email protected]>

* fix linter issue

Signed-off-by: maryaB-osr <[email protected]>

* removed mentions of line numbers, plus other reviews

Signed-off-by: maryaB-osr <[email protected]>

* removed comments from long code blocks

Signed-off-by: maryaB-osr <[email protected]>

* removed parenthesis from file names

Signed-off-by: maryaB-osr <[email protected]>

* final nits

Signed-off-by: maryaB-osr <[email protected]>

* macOS users already have dependencies installed

Signed-off-by: maryaB-osr <[email protected]>

* Consistent indentation in code blocks

Signed-off-by: Shane Loretz <[email protected]>

* unneeded codeblock line

Signed-off-by: maryaB-osr <[email protected]>

* New tutorial for service/client with Python (#372)

* New tutorial for service/client with Python

Signed-off-by: maryaB-osr <[email protected]>

* title underline too short

Signed-off-by: maryaB-osr <[email protected]>

* trailing whitespace

Signed-off-by: maryaB-osr <[email protected]>

* fix indentation and other nits

Signed-off-by: maryaB-osr <[email protected]>

* Consistent indentation in code blocks

Signed-off-by: Shane Loretz <[email protected]>

* wrong section

Signed-off-by: maryaB-osr <[email protected]>

* New tutorial for ROS 2 launch files (#353)

* New tutorial for ROS 2 launch files

Signed-off-by: maryaB-osr <[email protected]>

* Forgot to include in toctree

Signed-off-by: maryaB-osr <[email protected]>

* trailing white space

Signed-off-by: maryaB-osr <[email protected]>

* missing period

Co-Authored-By: Chris Lalancette <[email protected]>

* inside pkg > provided by pkg

Co-Authored-By: Michel Hidalgo <[email protected]>

* python modules explanation

Co-Authored-By: Michel Hidalgo <[email protected]>

* handful of reviews

Signed-off-by: maryaB-osr <[email protected]>

* linter & added next steps to rqt_console

Signed-off-by: maryaB-osr <[email protected]>

* more trailing whitespaces...

Signed-off-by: maryaB-osr <[email protected]>

* trying linenos

Signed-off-by: maryaB-osr <[email protected]>

* adjust indented space on linenos

Signed-off-by: maryaB-osr <[email protected]>

* another attempt at linenos indentation

Signed-off-by: maryaB-osr <[email protected]>

* change indentation

Signed-off-by: maryaB-osr <[email protected]>

* fix indentation on python block

Signed-off-by: maryaB-osr <[email protected]>

* give up on linenos for now

Signed-off-by: maryaB-osr <[email protected]>

* fixed indentation...?

Signed-off-by: maryaB-osr <[email protected]>

* New tutorial for C++ pub/sub (#366)

* New tutorial for C++ pub/sub

Signed-off-by: maryaB-osr <[email protected]>

* try C++ code highlighting

Signed-off-by: maryaB-osr <[email protected]>

* one incorrect directive

Signed-off-by: maryaB-osr <[email protected]>

* fixed some indentation

Signed-off-by: maryaB-osr <[email protected]>

* changed entry points to executables

Signed-off-by: maryaB-osr <[email protected]>

* removed parenthesis from file name

Signed-off-by: maryaB-osr <[email protected]>

* New branch for cleaning up staging

This commit organizes the order of the tutorials,
adds an introduction to the beginner tutorials,
and hyphenates all the page names

Signed-off-by: maryaB-osr <[email protected]>

* added next steps sections and other internal links

Signed-off-by: maryaB-osr <[email protected]>

* change msg show to interface show

Signed-off-by: maryaB-osr <[email protected]>

* linter

Signed-off-by: maryaB-osr <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@dirk-thomas dirk-thomas dirk-thomas left review comments

@clalancette clalancette clalancette approved these changes

@tfoote tfoote tfoote approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@maryaB-osr @clalancette @tfoote @dirk-thomas @mjcarroll