Skip to content

Commit 3121402

Browse files
authored
New pages and structure for core tutorials (#147)
* Prepared tutorials overview page. Signed-off-by: Ralph Lange <ralph.lange@de.bosch.com> * Prepared pages for 'first application' tutorials amd moved existing content accordingly. Signed-off-by: Ralph Lange <ralph.lange@de.bosch.com> * Prepared pages for 'first application' tutorials amd moved existing content accordingly. Signed-off-by: Ralph Lange <ralph.lange@de.bosch.com> * Prepared structure and menu for further clean-up #143. Signed-off-by: Ralph Lange <ralph.lange@de.bosch.com> * Renamed tutorial on middleware configuration #143. Signed-off-by: Ralph Lange <ralph.lange@de.bosch.com> * Improved title of middleware configuration tutorial #143 Signed-off-by: Ralph Lange <ralph.lange@de.bosch.com> * Created tutorials overview page #143. Signed-off-by: Ralph Lange <ralph.lange@de.bosch.com> * Typos. Signed-off-by: Ralph Lange <ralph.lange@de.bosch.com>
1 parent 8c55dcc commit 3121402

17 files changed

Lines changed: 45 additions & 406 deletions

File tree

‎_data/docs.yml‎

Lines changed: 6 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -40,16 +40,17 @@
4040

4141
- title: Core Tutorials
4242
docs:
43-
- tutorials/core/getting_started
44-
- tutorials/core/getting_started_embedded
45-
- tutorials/core/getting_started_simulator
43+
- tutorials/core/overview
44+
- tutorials/core/first_application_linux
45+
- tutorials/core/first_application_rtos
4646
- tutorials/core/programming_rcl_rclc
4747
- tutorials/core/microxrcedds_rmw_configuration
4848

4949
- title: Advanced Tutorials
5050
docs:
5151
- tutorials/advanced/microros_nuttx_bsp
5252
- tutorials/advanced/tracing
53+
- tutorials/advanced/zephyr_emulator
5354

5455
- title: Demos
5556
docs:
@@ -59,9 +60,8 @@
5960
- tutorials/demos/fiware_demo
6061
- tutorials/demos/complete_demo
6162

62-
- title: Advanced Tutorials with Nuttx
63+
- title: Nuttx-specific Tutorials
6364
docs:
64-
- tutorials/advanced/nuttx/nuttx_getting_started
6565
- tutorials/advanced/nuttx/nsh_usb
6666
- tutorials/advanced/nuttx/nsh_uart
6767
- tutorials/advanced/nuttx/6lowpan_config
@@ -70,15 +70,7 @@
7070
- tutorials/advanced/nuttx/add_microros_config
7171
- tutorials/advanced/nuttx/microros_6lowpan_tutorial
7272

73-
- title: Advanced Tutorials with FreeRTOS
73+
- title: Getting Started Tutorials with FreeRTOS and Zephyr
7474
docs:
7575
- tutorials/advanced/freertos/freertos_getting_started
76-
77-
- title: Advanced Tutorials with Zephyr
78-
docs:
7976
- tutorials/advanced/zephyr/zephyr_getting_started
80-
- tutorials/advanced/zephyr/zephyr_emulator
81-
82-
- title: Advanced Tutorials with Linux
83-
docs:
84-
- tutorials/advanced/linux/linux_getting_started

‎_docs/tutorials/advanced/freertos/freertos_getting_started/index.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@ title: FreeRTOS Getting Started
33
permalink: /docs/tutorials/advanced/freertos/freertos_getting_started/
44
---
55

6+
**Please note that this tutorial will soon be integrated with [First micro-ROS application on an RTOS](/docs/tutorials/core/first_application_rtos/)!**
7+
68
This tutorial aims to create a new micro-ROS application on **[Olimex STM32-E407](https://www.olimex.com/Products/ARM/ST/STM32-E407/open-source-hardware)** evaluation board with **[FreeRTOS RTOS](https://www.freertos.org/)**
79

810
<div>

‎_docs/tutorials/advanced/zephyr/zephyr_getting_started/index.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@ title: Zephyr Getting Started
33
permalink: /docs/tutorials/advanced/zephyr/zephyr_getting_started/
44
---
55

6+
**Please note that this tutorial will soon be integrated with [First micro-ROS application on an RTOS](/docs/tutorials/core/first_application_rtos/)!**
7+
68

79
This tutorial aims to create a new micro-ROS application on **[Olimex STM32-E407](https://www.olimex.com/Products/ARM/ST/STM32-E407/open-source-hardware)** evaluation board with **[Zephyr RTOS](https://www.zephyrproject.org/)**
810

_docs/tutorials/advanced/zephyr/zephyr_emulator/imgs/4.jpg renamed to _docs/tutorials/advanced/zephyr_emulator/imgs/4.jpg

File renamed without changes.

_docs/tutorials/advanced/zephyr/zephyr_emulator/index.md renamed to _docs/tutorials/advanced/zephyr_emulator/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Zephyr Emulator
3-
permalink: /docs/tutorials/advanced/zephyr/zephyr_emulator/
3+
permalink: /docs/tutorials/advanced/zephyr_emulator/
44
---
55

66
This tutorial aims to create a new micro-ROS application on with **[Zephyr RTOS](https://www.zephyrproject.org/)** emulator (also known as [Native POSIX](https://docs.zephyrproject.org/latest/boards/posix/native_posix/doc/index.html)).

_docs/tutorials/advanced/linux/linux_getting_started/index.md renamed to _docs/tutorials/core/first_application_linux/index.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
11
---
2-
title: Linux Getting Started
3-
permalink: /docs/tutorials/advanced/linux/linux_getting_started/
2+
title: First micro-ROS Application on Linux
3+
permalink: /docs/tutorials/core/first_application_linux/
44
---
55

6-
This tutorial aims to create a new micro-ROS application on Linux for testing purposes.
6+
This tutorial teaches you how to create a first micro-ROS application on Linux for testing purposes. In the follow-up tutorial [*First micro-ROS application on an RTOS*](/docs/tutorials/core/first_application_rtos/), you'll learn how to build and bring this application on a microcontroller running the RTOS NuttX, FreeRTOS, or Zephyr.
7+
78

89
## Adding a new micro-ROS app
910

_docs/tutorials/advanced/nuttx/nuttx_getting_started/images/1.jpg renamed to _docs/tutorials/core/first_application_rtos/images/1.jpg

File renamed without changes.

_docs/tutorials/advanced/nuttx/nuttx_getting_started/images/2.jpg renamed to _docs/tutorials/core/first_application_rtos/images/2.jpg

File renamed without changes.

_docs/tutorials/advanced/nuttx/nuttx_getting_started/images/5.jpg renamed to _docs/tutorials/core/first_application_rtos/images/5.jpg

File renamed without changes.

_docs/tutorials/advanced/nuttx/nuttx_getting_started/images/nuttx_examples.png renamed to _docs/tutorials/core/first_application_rtos/images/nuttx_examples.png

File renamed without changes.

0 commit comments

Comments
 (0)