osrf / vrx

Virtual RobotX (VRX) resources.
Apache License 2.0
390 stars 180 forks source link

Rename 2022_practice directory and worlds #647

Closed M1chaelM closed 1 year ago

M1chaelM commented 1 year ago

We ported the 2022 practice worlds from VRX Classic to VRX 2.0+ and put them in the vrx_gz/worlds/2022_practice/ directory. While working on VRX 2023, we have updated these worlds and added to them so the name is increasingly misleading.

To resolve this we need to rename the 2022_practice directory to 2023_practice, and rename all the sdf files stored in the directory so they start with the prefix practice_2023 instead of practice_2022. We then need to update the phase 2 and phase 3 tutorials to refer to the 2023 practice worlds.

caguero commented 1 year ago

I have updated the links to the practice worlds in these two tutorials.

caguero commented 1 year ago

@M1chaelM , could you double-check the tutorials please?

M1chaelM commented 1 year ago

The numbers have been changed, but the resulting sentences are confusing:

To help you prepare, we will provide an updated Phase 2 Task Practice tutorial and practice worlds for VRX 2023. These are under development. However, the Phase 2 Task Practice tutorial and example worlds for VRX 2023 may provide a useful starting point. The example worlds provided will be representative of the task configurations and environmental conditions specified in the task documentation.

I can update this. Are we planning to release more practice worlds later? Or is this it?

I will also fix the links, which are pointing to the wrong tutorial now.

M1chaelM commented 1 year ago

This turned out to be a bit of a rabbit hole. There was no Phase 2 Task Practice tutorial for VRX 2023, so I created one from a copy of VRX 2022. However, the 2022 tutorial had links to a page for each task that described the features of each practice world (0, 1, and 2) for that task:

Practice World Details

Task 1: Stationkeeping Practice Worlds

Task 2: Wayfinding Practice Worlds

Task 3: Perception Practice Worlds

Task 4: Wildlife Practice Worlds

Task 5: Gymkhana Practice Worlds

Task 6: Scan and Dock and DeliverPractice Worlds

I looked through these and I'm not sure how much value they add, mostly because the descriptions are very generic copy/paste job. For now, I'm just going to remove the links. @caguero and @j-herman what do you think? Would it be useful to do something like this for the 8 VRX 2023 tasks? Alternately, we could also just have a table or something that summarizes all the worlds for all tasks.

M1chaelM commented 1 year ago

Oh, we also need to add this tutorial to our tutorials menu somewhere to avoid the hidden tutorial maze problem.

caguero commented 1 year ago

I can update this. Are we planning to release more practice worlds later? Or is this it?

I don't plan to add more practice worlds.

M1chaelM commented 1 year ago

OK, I think the tutorials are fixed now.

caguero commented 1 year ago

I did a pass on the tutorials. They look good to me after fixing a few things.