Skip to content

Commit 9a1f7ef

Browse files
ralph-langeBorjaOuterelo
ralph-lange
authored and
BorjaOuterelo
committed
Fix redirects and subfolders (#50)
* Moved basic tutorial to folder 'basic' and ensured redirects from all possible parent folder urls. Signed-off-by: Ralph Lange (CR/AEE1) <ralph.lange@de.bosch.com> * Removed duplicate redirect.
1 parent 08efb2b commit 9a1f7ef

10 files changed

Lines changed: 19 additions & 26 deletions

File tree

‎_data/docs.yml‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,15 @@
66

77
- title: Basic Tutorials
88
docs:
9-
- tutorials/getting_started
10-
- tutorials/getting_started_embedded
11-
- tutorials/getting_started_simulator
9+
- tutorials/basic/getting_started
10+
- tutorials/basic/getting_started_embedded
11+
- tutorials/basic/getting_started_simulator
1212

1313
- title: Advanced Tutorials
1414
docs:
1515
- tutorials/advanced/nuttx_getting_started
16-
- tutorials/advanced/debugging-gdb-openocd
17-
- tutorials/advanced/debugging-vscode
16+
- tutorials/advanced/debugging_gdb_openocd
17+
- tutorials/advanced/debugging_vscode
1818
- tutorials/advanced/6lowpan_nuttx_rpi
1919

2020
- title: Concepts

‎_docs/concepts/rtos/index.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
22
title: Real-Time Operating Systems (RTOS)
33
permalink: /docs/concepts/rtos/
4+
redirect_from: /docs/concepts/
45
---
56

67
# RTOS

‎_docs/overview/index.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
22
title: Overview
33
permalink: /docs/overview/
4+
redirect_from: /docs/
45
---
56

67
[micro-ROS](https://cordis.europa.eu/project/rcn/213167_en.html) puts ROS2 onto microcontrollers, making them first class participants of the ROS 2 environment.

_docs/tutorials/debugging/gdb-openocd.md renamed to _docs/tutorials/advanced/debugging_gdb_openocd/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Debugging a NuttX target with GDB and OpenOCD
3+
permalink: /docs/tutorials/advanced/debugging_gdb_openocd/
34
author: Ingo Lütkebohle
4-
permalink: /docs/tutorials/advanced/debugging-gdb-openocd/
55
---
66

77
Rare is the program that works on the first try -- so you will usually need a debugger. This is even more true on an embedded device, where "printf"-style debugging is very cumbersome.
@@ -133,7 +133,7 @@ In my case, this is the NSH thread which is waiting for some input.
133133
This concludes this basic tutorial on getting gdb to run with OpenOCD and NuttX support.
134134

135135
Using gdb on the command line is considered a bit cumbersome by many. So if you know your way
136-
around an IDE with gdb support, integrating it should be easy. We leave that as an exercise
136+
around an IDE with gdb support, integrating it should be easy. We leave that as an exercise
137137
for the reader ;-)
138138

139139
There are also IDEs with microcontroller support -- stay tuned for another tutorial with more

_docs/tutorials/debugging/vscode-start.md renamed to _docs/tutorials/advanced/debugging_vscode/index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Debugging with Visual Studio Code
3-
permalink: /docs/tutorials/advanced/debugging-vscode/
3+
permalink: /docs/tutorials/advanced/debugging_vscode/
44
author: Ingo Lütkebohle
55
---
66

@@ -63,9 +63,9 @@ As in the gdb tutorial, initially you won't see much because the program is stop
6363

6464
### Adding an SVD File
6565

66-
You may have noticed that on the left-hand side, there is a sub-window called "Cortex Peripherals" which simply states "No SVD File loaded". SVD means "System View Description" and is a standard format which microcontroller vendors use to describe the available features of their MCUs.
66+
You may have noticed that on the left-hand side, there is a sub-window called "Cortex Peripherals" which simply states "No SVD File loaded". SVD means "System View Description" and is a standard format which microcontroller vendors use to describe the available features of their MCUs.
6767

68-
For example, in the case of our STM32-E407 board, which features an STM32F407ZGT6 MCU, we can download the SVD description from [STM's web-page for the STM32F407ZG series](https://www.st.com/en/microcontrollers-microprocessors/stm32f407zg.html). In the "HW Model, CAD Libraries & SVD", you will find a link to the [STM32F4 series SVD](https://www.st.com/resource/en/svd/stm32f4_svd.zip).
68+
For example, in the case of our STM32-E407 board, which features an STM32F407ZGT6 MCU, we can download the SVD description from [STM's web-page for the STM32F407ZG series](https://www.st.com/en/microcontrollers-microprocessors/stm32f407zg.html). In the "HW Model, CAD Libraries & SVD", you will find a link to the [STM32F4 series SVD](https://www.st.com/resource/en/svd/stm32f4_svd.zip).
6969

7070
Extract the SVD and then add an `svdFile` attribute to the launch configuration. The full configuration will look like this:
7171

‎_docs/tutorials/advanced/index.md‎

Lines changed: 0 additions & 11 deletions
This file was deleted.

_docs/tutorials/getting_started/index.md renamed to _docs/tutorials/basic/getting_started/index.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
---
22
title: Getting Started with your computer (WIP)
3-
permalink: /docs/tutorials/getting_started/
3+
permalink: /docs/tutorials/basic/getting_started/
4+
redirect_from: /docs/tutorials/basic/
5+
redirect_from: /docs/tutorials/
46
---
57

68
Table of contents

_docs/tutorials/getting_started_embedded/index.md renamed to _docs/tutorials/basic/getting_started_embedded/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Getting Started with an embedded board (WIP)
3-
permalink: /docs/tutorials/getting_started_embedded/
3+
permalink: /docs/tutorials/basic/getting_started_embedded/
44
---
55

66
Table of contents

_docs/tutorials/getting_started_simulator/index.md renamed to _docs/tutorials/basic/getting_started_simulator/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Getting Started with simulator (WIP)
3-
permalink: /docs/tutorials/getting_started_simulator/
3+
permalink: /docs/tutorials/basic/getting_started_simulator/
44
author: Iñigo Muguruza Goenaga, Juan Muñoz Flores
55
---
66

‎_includes/topnav.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,8 @@
1414
<div id="navbar" class="collapse navbar-collapse">
1515
<ul class="nav navbar-nav">
1616
<li {% if page.path contains '_docs/overview' %} class="active" {% endif %}><a href="{{ "/docs/overview/" | prepend: site.baseurl }}">Overview</a></li>
17-
<li {% if page.path contains '_docs/concepts' %} class="active" {% endif %}><a href="{{ "/docs/concepts/rtos" | prepend: site.baseurl }}">Concepts</a></li>
18-
<li {% if page.path contains '_docs/tutorials' %} class="active" {% endif %}><a href="{{ "/docs/tutorials/getting_started" | prepend: site.baseurl }}">Tutorials</a></li>
17+
<li {% if page.path contains '_docs/concepts' %} class="active" {% endif %}><a href="{{ "/docs/concepts/" | prepend: site.baseurl }}">Concepts</a></li>
18+
<li {% if page.path contains '_docs/tutorials' %} class="active" {% endif %}><a href="{{ "/docs/tutorials/" | prepend: site.baseurl }}">Tutorials</a></li>
1919
<li {% if page.sectionid=='posts' %} class="active" {% endif %}><a href="{{ site.posts.first.url | prepend: site.baseurl }}">Blog</a></li>
2020
</ul>
2121
<ul class="nav navbar-nav navbar-right">

0 commit comments

Comments
 (0)