Splitting of repo in submodules + Docker (#474)

duckietown · Jun 25, 2018 · 56c1a4b · 56c1a4b
1 parent 663f672
commit 56c1a4b
Show file tree

Hide file tree

Showing 19 changed files with 122 additions and 119 deletions.
diff --git a/19_student_guide.md b/19_student_guide.md
@@ -62,7 +62,7 @@ If after 24 hours from sending the questionnaire you haven't received the invite
 contact HR representative Kirsten Bowser &lt;akbowser@gmail.com&gt;.
 
 
-**What is Slack?** More details about Slack are available [here](#slack).
+**What is Slack?** More details about Slack are available [here](+software_reference#slack).
 In particular, remember to disable email notifications.
 
 **Slack username**. When you accept your Slack invite, please identify yourself with first and last names followed by a "-" and your institution.

diff --git a/26_git.md b/26_git.md
@@ -38,7 +38,7 @@ In the documentation, this is referred to as `DUCKIETOWN_ROOT`.
 
 During the first part of the class, you will only read from this repository.
 
-### Duckiefleet 
+### Duckiefleet
 
 The [duckiefleet](http://github.com/duckietown/duckiefleet)
 repository contains the data specific to this instance of the class.
@@ -52,7 +52,7 @@ In the documentation, the location of this repo is referred to as `DUCKIEFLEET_R
 You will be asked to write to this repository, to update the robot DB
 and the people DB, and for doing exercises.
 
-### exercises-fall2017 
+### exercises-fall2017
 
 For homework submissions, we will use the following URL:
 
@@ -151,7 +151,7 @@ You should put your homework files in folder at:
 
     ![DUCKIEFLEET_HOMEWORK_ROOT]/homeworks/![XX_homework_name]/![YOUR_ROBOT_NAME]
 
-Some homeworks might not require ROS, they should go in a subfolder called `scripts`. ROS homeworks should go in packages which are generated using the process described here: [](#sec:ros-python-howto). For an example see `![DUCKIEFLEET_HOMEWORK_ROOT]/homeworks/01_data_processing/shamrock`.
+Some homeworks might not require ROS, they should go in a subfolder called `scripts`. ROS homeworks should go in packages which are generated using the process described here: [](+software_devel#ros-python-howto). For an example see `![DUCKIEFLEET_HOMEWORK_ROOT]/homeworks/01_data_processing/shamrock`.
 
 
 Note: To make your ROS packages findable by ROS you should add a symlink from your `![DUCKIEFLEET_HOMEWORK_ROOT]` to `duckietown/catkin_ws/src`.
@@ -191,7 +191,7 @@ We will ask to create a "Pull Request" from your private repo.
 
 
 
-### For U de M students who have already submitted homework to the previous duckiefleet-2017 repo 
+### For U de M students who have already submitted homework to the previous duckiefleet-2017 repo
 
 <div class='only-montreal' markdown="1">
 

diff --git a/27_help.md b/27_help.md
@@ -39,8 +39,8 @@ The goal for the instructions is that anybody is able to follow them.
 Last year, we managed to have two 15-year-old students
 reproduce the Duckiebot from instructions.
 
-See: How to edit the documentation is explained in [](#book:contribute).
+See: How to edit the documentation is explained in [](+duckumentation#contribute).
-In particular, the notation on how to insert a comment is explained in [](#notes-and-questions).
+
 
 Note that because we use Git, we can always keep track of changes, and there is no risk of causing damage.
 
@@ -71,12 +71,12 @@ fixed and the addendum is deleted.
 
 ### Case: You find the instructions unclear and you need clarification
 
-Action: Ask for clarification on the appropriate Slack channel. For a list of slack channels that could be helpful see [](#slack_channels). Once the ambiguity is clarified to your satisfaction, either you or the appropriate staff member should update the documentation if appropriate. For instructions on this see [](#book:contribute).
+Action: Ask for clarification on the appropriate Slack channel. For a list of slack channels that could be helpful see [](#slack_channels). Once the ambiguity is clarified to your satisfaction, either you or the appropriate staff member should update the documentation if appropriate. For instructions on this see [](+duckumentation#contribute).
 
 ### Case: You understand the instructions but you are blocked for some reason
 
 Action: This is more serious than the previous.
-Open an issue [on the `duckiefleet-fall2017` github page](https://github.com/duckietown/duckiefleet-fall2017/issues). Once the issue is resolved, either you or the appropriate staff member should update the documentation if appropriate. For instructions on this see [](#book:contribute).
+Open an issue [on the `duckiefleet-fall2017` github page](https://github.com/duckietown/duckiefleet-fall2017/issues). Once the issue is resolved, either you or the appropriate staff member should update the documentation if appropriate. For instructions on this see [](+duckumentation#contribute).
 
 
 ### Case: You are having a technical issue related to building the documentation

diff --git a/29_class_journal_ETH_part1.md b/29_class_journal_ETH_part1.md
@@ -27,18 +27,18 @@ These are the slides we showed:
 
 ### Feedback form
 
-Please help us making the experience better by [providing feedback (can be anonymous)](https://tinyurl.com/y77pbv7n)
+Please help us making the experience better by [providing feedback (can be anonymous)](https://tinyurl.com/y77pbv7n).
 
 
 ### Pointers to reading materials
 
 Read about Duckietown's history and watch the Duckumentary.
 
-See: [](#duckietown-project)
+See: [](+the_duckietown_project#duckietown-project)
 
 Start learning about Git and Github.
 
-See: [](#git-reference)
+See: [](+software_devel#git-reference)
 
 Montreal, Chicago? What's happening?
 
@@ -177,9 +177,9 @@ We sent the final list to the Department; so hopefully in a couple of days the s
 
 The "lab" time on Friday consists in an empty room for you to use as you wish, for example to assembe the robots together. In particular, it's on the same floor of the Duckietown room and the IDSC lab.
 
-The instructions for assembling the Duckiebots are [here](#building-duckiebot-c0). Note that you
+The instructions for assembling the Duckiebots are [here](+opmanual_duckiebot#building-duckiebot-c0). Note that you
 don't have to do the parts that we did for you: buying the parts, soldering the boards, and reproducing the image.
 
 Expected progress: We are happy if we see everybody reaching up to
-[](#rc-cam-launched-remotely) by Monday October 9. You are encouraged to start very early;
+[](+opmanual_duckiebot#rc-cam-launched-remotely) by Monday October 9. You are encouraged to start very early;
 it's likely that you will not receive much help on Sunday October 8...
diff --git a/29_class_journal_ETH_part2.md b/29_class_journal_ETH_part2.md
@@ -9,7 +9,7 @@ A couple of announcements:
 
 3. The "lab" time tomorrow consists in an empty room for you to use as you wish, for example to assemble the robots together. In particular, it's on the same floor of the Duckietown room and the IDSC lab.
 
-4. The instructions for assembling the Duckiebots are [here](#building-duckiebot-c0). Note that we did for you step I-2 (buying the parts) and I-3 (soldering the boards); and I-6 is optional.
+4. The instructions for assembling the Duckiebots are [here](+opmanual_duckiebot#building-duckiebot-c0). Note that we did for you step I-2 (buying the parts) and I-3 (soldering the boards); and I-6 is optional.
 
 5. We are happy if we see everybody reaching I-13 by the Monday after next. I encourage you to start sooner than later.
 
@@ -104,7 +104,7 @@ Please take a video of the robot as it drives with joystick control, as describe
 
 ### Camera calibration {#Zurich-camera-calibration}
 
-[Go forth and calibrate the camera!](#camera-calib) And get help in `#help-camera-calib`.
+[Go forth and calibrate the camera!](+opmanual_duckiebot#camera-calib) And get help in `#help-camera-calib`.
 
 
 ### Wheel calibration {#Zurich-wheel-calibration status=draft}
@@ -242,7 +242,7 @@ A few references for planning of Andrea Censi:
 ## Nov 27 (Mon) Inermediate design Report {#Zurich-2017-11-27}
 
 
-- First Lecture: The intermediate Design report is introduced here[template-int-report](#template-int-report). It is due on Monday 4th of December. 
+- First Lecture: The intermediate Design report is introduced [here](+class_2017_projects#template-int-report). It is due on Monday 4th of December. 
 
 - Second Lecture was left for project discussion and interaction.
 

diff --git a/31_class_schedule_UDEM.md b/31_class_schedule_UDEM.md
@@ -16,11 +16,11 @@ Slides:
 
 Book materials:
 
-* [](#duckietown-project)
+* [](+the_duckietown_project#duckietown-project)
 
-* [](#autonomous-vehicles)
+* [](+learning_materials#autonomous-vehicles)
 
-* [](#autonomy-overview)
+* [](+learning_materials#autonomy-overview)
 
 ## Friday Sept 8
 
@@ -87,15 +87,15 @@ Slides:
 
 Book Materials:
 
-* [Modern Robotic Systems](#modern-robotic-systems)
+* [Modern Robotic Systems](+learning_materials#modern-robotic-systems)
 
-* [System Architecture Basics](#system-architectures-basics)
+* [System Architecture Basics](+learning_materials#system-architectures-basics)
 
-* [Autonomy Architectures](#autonomy-architectures)
+* [Autonomy Architectures](+learning_materials#autonomy-architectures)
 
-* [Representations](#representations)
+* [Representations](+preliminaries#representations)
 
-* [Probability Basics](#probability_basics)
+* [Probability Basics](+preliminaries#probability_basics)
 
 Lab (11:30 - 12:30)
 
@@ -119,9 +119,9 @@ Slides:
 
 Book Materials:
 
-* [Introduction to ROS](#introduction_to_ros)
+* [Introduction to ROS](+software_reference#introduction_to_ros)
 
-* [Middlewares](#middleware)
+* [Middlewares](+learning_materieals#middleware)
 
 
 Lab (12:30 - 1:30)
@@ -186,11 +186,11 @@ Slides:
 
 Book Material:
 
-* [](#coordinate_systems)
+* [](+preliminaries#coordinate_systems)
 
-* [](#reference_frames)
+* [](+preliminaries#reference_frames)
 
-* [](#duckiebot-modeling)
+* [](+learning_materials#duckiebot-modeling)
 
 
 
@@ -204,13 +204,13 @@ Slides:
 
 Book Material:
 
-* [](#CV_basics)
+* [](+learning_materials#CV_basics)
 
-* [](#camera-geometry)
+* [](+learning_materials#camera-geometry)
 
-* [](#camera-calibration)
+* [](+learning_materials#camera-calibration)
 
-* [](#image-filtering)
+* [](+learning_materials#image-filtering)
 
 
 Lab (11:30 - 12:30) in AA 2333
@@ -225,9 +225,9 @@ Slides:
 
 Book Material:
 
-* [](#image-filtering)
+* [](+learning_materials#image-filtering)
 
-* [](#line_detection)
+* [](+learning_materials#line_detection)
 
 
 Lab (12:30 - 1:30) in AA 2333
@@ -328,7 +328,7 @@ Class 11:30-12:30
 
  - Motion Planning. [(pdf)](https://github.com/duckietown/lectures/blob/master/2_given/2017-11-08-udem-motion_planning.pdf), [(pptx)](https://github.com/duckietown/lectures/blob/master/2_given/2017-11-08-udem-motion_planning.pptx)
 
-[Checkoff Navigation](#checkoff_navigation) initiated. Deadline Nov 15 @ 11pm. 
+[Checkoff Navigation](+class_fall_2017#checkoff_navigation) initiated. Deadline Nov 15 @ 11pm. 
 
 ## Thursday Nov. 9
 

diff --git a/33_class_schedule_TTIC.md b/33_class_schedule_TTIC.md
@@ -8,10 +8,10 @@ The following is a list of the current checkoffs, along with the date and time w
 
 &nbsp;
 
-* **Friday October 6, 5pm CT**: [](#part:checkoff_assembly_configuration)
+* **Friday October 6, 5pm CT**: [](#checkoff_assembly_configuration)
-* **Wednesday October 18, 11:59pm CT**: [](#part:checkoff_take_a_log)
+* **Wednesday October 18, 11:59pm CT**: [](#checkoff_take_a_log)
-* **Sunday October 22, 11:59pm CT**: [](#part:checkoff_calibration)
+* **Sunday October 22, 11:59pm CT**: [](#checkoff_calibration)
-* **Wednesday November 15, 11:59pm CT**: [](#part:checkoff_navigation)
+* **Wednesday November 15, 11:59pm CT**: [](#checkoff_navigation)
 
 
 ## Problem Sets:
@@ -26,9 +26,9 @@ Note: Please keep track of how much time you spend on each problem set. We will
 
 &nbsp;
 
-* **Friday October 13, 11:59pm CT**: [](#part:homework-data-processing-ttic)
+* **Friday October 13, 11:59pm CT**: [](#homework-data-processing-ttic)
-* **Friday October 27, 11:59pm CT**: [](#part:homework-augmented-reality)
+* **Friday October 27, 11:59pm CT**: [](#homework-augmented-reality)
-* **Friday November 17, 11:59pm CT**: [](#part:homework-lane-filtering)
+* **Friday November 17, 11:59pm CT**: [](#homework-lane-filtering)
 
 
 
@@ -42,9 +42,9 @@ Note: Please keep track of how much time you spend on each problem set. We will
 
 ### Reading Material
 
-* [](#duckietown-project)
+* [](+the_duckietown_project#duckietown-project)
 
-* [](#autonomy-overview)
+* [](+learning_materials#autonomy-overview)
 
 
 ### Feedback Form
@@ -102,18 +102,18 @@ Please help us making the experience better by [providing feedback (can be anony
 
 ### Reading Material
 
-* [](#part:autonomous-vehicles)
+* [](+learning_materials#autonomous-vehicles)
 
-* [](#autonomy-overview)
+* [](+learning_materials#autonomy-overview)
 
-* [](#part:modern-robotic-systems)
+* [](+learning_materials#modern-robotic-systems)
 
-* [](#part:system-architectures-basics)
+* [](+learning_materials#system-architectures-basics)
 
 
 ### Assignments
 
-* [](#part:checkoff_assembly_configuration) is due by Friday 5pm CT. Note: The page provides the URL where you should upload your video(s).
+* [](#checkoff_assembly_configuration) is due by Friday 5pm CT. Note: The page provides the URL where you should upload your video(s).
 
 ### Feedback Form
 
@@ -136,11 +136,11 @@ Please help us making the experience better by [providing feedback (can be anony
 
 ### Reading Material
 
-* [](#part:representations)
+* [](+preliminaries#representations)
 
-* [](#part:networking)
+* [](+learning_materials#networking)
 
-* [](#part:system-architectures-basics)
+* [](+learning_materials#system-architectures-basics)
 
 
 ### Feedback Form
@@ -155,14 +155,14 @@ Please help us making the experience better by [providing feedback (can be anony
 
 **Important**: Before starting these tutorials, make sure that you completed the following:
 
-See: [](#setup-laptop)
+See: [](+opmanual_duckiebot#setup-laptop)
 
 Before coming to class, please read through the following tutorials:
 
 * [https://tinyurl.com/ROS101-Intro](https://tinyurl.com/ROS101-Intro)
 * [http://wiki.ros.org/ROS/Tutorials#Beginner_Level](http://wiki.ros.org/ROS/Tutorials#Beginner_Level)
 Complete all the tutorials in Section 1.1 Beginner Level.
-There is no need to install ROS as the tutorial instructs, because you already installed as part of the [setup process](#setup-laptop).
+There is no need to install ROS as the tutorial instructs, because you already installed as part of the [setup process](+opmanual_duckiebot#setup-laptop).
 Sections 11 and 14 of this tutorial will ask you to implement simple ROS nodes using C++. You can skip them since Sections 12 and 15 are basically the same but using Python.
 
 ### Lecture Content
@@ -173,7 +173,7 @@ Sections 11 and 14 of this tutorial will ask you to implement simple ROS nodes u
 
 ### Reading Material
 
-* [](#duckiebot-modeling)
+* [](+learning_materials#duckiebot-modeling)
 
 
 ### Feedback Form
@@ -194,8 +194,8 @@ Please help us making the experience better by [providing feedback (can be anony
 
 ### Reading Material
 
-* [](#CV_basics)
+* [](+learning_materials#CV_basics)
-* [](#camera-geometry)
+* [](+learning_materials#camera-geometry)
 * Richard Szeliski, *Computer Vision: Algorithms and Applications*, Chapters 1 and 2 (available [online](http://szeliski.org/Book/))
 * David A. Forsyth and Jean Ponce, *Computer Vision: A Modern Approach*, Chapters 1 and 2
 
@@ -209,7 +209,7 @@ Please help us making the experience better by [providing feedback (can be anony
 
 ## Monday, October 16: Camera Calibration and Image Filtering
 
-Note: [The second checkoff](#part:checkoff_take_a_log) is due by 11:59pm CT Wednesday.
+Note: [The second checkoff](#checkoff_take_a_log) is due by 11:59pm CT Wednesday.
 
 ### Lecture Content
 
@@ -221,9 +221,9 @@ Note: [The second checkoff](#part:checkoff_take_a_log) is due by 11:59pm CT Wedn
 
 ### Reading Material
 
-* [](#CV_basics)
+* [](+learning_materials#CV_basics)
-* [](#camera-calibration)
+* [](+opmanual_duckiebot#camera-calibration)
-* [](#image-filtering)
+* [](+learning_materials#image-filtering)
 * Richard Szeliski, *Computer Vision: Algorithms and Applications*, Chapters 3 and 6 (available [online](http://szeliski.org/Book/))
 * David A. Forsyth and Jean Ponce, *Computer Vision: A Modern Approach*, Chapters 5.3 and 7
 
@@ -236,7 +236,7 @@ Please help us making the experience better by [providing feedback (can be anony
 
 ## Wednesday, October 18: Edge Detection and Lane Detection
 
-Note: [The third checkoff](#part:checkoff_calibration) is due by 11:59pm CT Sunday. Note that camera calibration is necessary for the next problem set, which will be posted soon.
+Note: [The third checkoff](#checkoff_calibration) is due by 11:59pm CT Sunday. Note that camera calibration is necessary for the next problem set, which will be posted soon.
 
 ### Lecture Content
 
@@ -251,7 +251,7 @@ Note: [The third checkoff](#part:checkoff_calibration) is due by 11:59pm CT Sund
 
 ### Reading Material
 
-* [](#line_detection)
+* [](+learning_materials#line_detection)
 * Richard Szeliski, *Computer Vision: Algorithms and Applications*, Chapters 3 and 4 (available [online](http://szeliski.org/Book/))
 * David A. Forsyth and Jean Ponce, *Computer Vision: A Modern Approach*, Chapters 7 and 8