Skip to content

Commit b256a1b

Browse files
FranFinpablogs9
andauthored
Different adjustments. (#251)
* Different adjustments. * Fix links Co-authored-by: Pablo Garrido <pablogs9@gmail.com>
1 parent 030d1ad commit b256a1b

7 files changed

Lines changed: 12 additions & 7 deletions

File tree

_data/docs.yml

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,6 @@
77
- overview/ROS_2_feature_comparison
88
- overview/docker_ci_status
99
- overview/users_and_clients
10-
- overview/fiware_interoperability
1110

1211

1312
- title: Client Library
@@ -43,6 +42,10 @@
4342
- concepts/benchmarking/results
4443
- concepts/benchmarking/memo_prof
4544

45+
- title: Interoperability with FIWARE
46+
docs:
47+
- concepts/fiware_interoperability
48+
4649
- title: Core Tutorials
4750
docs:
4851
- tutorials/core/overview

_docs/concepts/benchmarking/memo_prof/index.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
---
22
title: Memory profiling
33
redirect_from: /memo_prof/
4-
redirect_from: /concepts/memo_prof/
54
permalink: /docs/concepts/benchmarking/memo_prof/
65
---
76

File renamed without changes.

_docs/overview/fiware_interoperability/index.md renamed to _docs/concepts/fiware_interoperability/index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Interoperability with FIWARE
3-
permalink: /docs/overview/fiware_interoperability/
3+
permalink: /docs/concepts/fiware_interoperability/
44
---
55

66
## Motivation
@@ -33,7 +33,7 @@ To accomplish this, two different approaches can be taken:
3333
While the first approach might result in a more lightweight tool, it has several flaws, for instance a more difficult maintenance and the incapability of communicating with any other middleware, rather than ROS2 or micro-ROS.
3434
On the other hand, using an integration service platform, such as [SOSS](https://github.com/eProsima/soss_v2), enables automatically the possibility of communicating with a wide (and growing) set of middlewares, if their System Handle implementation is available.
3535

36-
## SOSS: System Of Systems Synthesizer
36+
## SOSS: System-Of-Systems-Synthesizer
3737

3838
**SOSS** addresses the task of providing a common interface for communicating software platforms that speak different languages.
3939
It is composed of a **core** library, which defines a set of abstract interfaces and provides some utility classes to form a plugin-based framework.
@@ -50,7 +50,7 @@ This common representation is provided, user-wise, using IDL definitions, which
5050

5151
<img width="600" src="imgs/soss.png">
5252

53-
## SOSS-FIWARE system handle
53+
## SOSS-FIWARE System Handle
5454

5555
The [FIWARE System Handle](https://github.com/eProsima/SOSS-FIWARE/tree/feature/xtypes-support) allows bringing information from and to FIWARE's Context Broker into the SOSS world.
5656
This [System Handle](https://soss.docs.eprosima.com/en/latest/sh_creation.html) is configured and launched in the same way as any SOSS System Handle.

_docs/overview/ROS_2_feature_comparison/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ Support for "bare-metal" microcontrollers | <span class="status_flag">&#10003;</
6868
Continuous Integration | <span class="status_flag">&#10003;&#8728;</span> | Currently, the CI for micro-ROS is distributed to GitHub and GitLab. *Until the end of 2020, all CI should be moved migrated completely to the new CI actions of GitHub.* Please note that those packages that are released for standard ROS 2 are also built and tested on [build.ros2.org](http://build.ros2.org/).
6969
Documentation | <span class="status_flag">&#10003;</span> | High-level documentation at [micro-ros.github.io](https://micro-ros.github.io/). For detailed information please consult the README.md files in the relevant micro-ROS repositories at [github.com/micro-ROS/](https://github.com/micro-ROS/). For information on the middleware implementation, take a look at the [Micro XRCE-DDS documentation](https://micro-xrce-dds.docs.eprosima.com/en/latest/).
7070
Peer-to-peer functionality | <span class="status_flag">&#10003;&#8728;</span> | Prototypical peer-to-peer functionality implemented over broadcast. No QoS available for the moment. *Roadmap: improve prototype to achieve true point-to-point connection.*
71-
Memory footprint | <span class="status_flag">&#10003;</span> | A comprehensive profiling of the memory consumption of typical micro-ROS applications can be found [here](https://micro-ros.github.io/docs/concepts/memo_prof/).
71+
Memory footprint | <span class="status_flag">&#10003;</span> | A comprehensive profiling of the memory consumption of typical micro-ROS applications can be found [here](/docs/concepts/benchmarking/memo_prof/).
7272

7373
Below, you can find the legend of the symbols used in the tables above.
7474

_docs/overview/hardware/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ permalink: /docs/overview/hardware/
3030

3131
Micro-ROS aims to **bring ROS 2 to a wide set of microcontrollers** to allow having first-class ROS 2 entities in the embedded world.
3232

33-
The main targets of micro-ROS are mid-range 32-bits microcontroller families. Usually, the minimum requirements for running micro-ROS in an embedded platform are memory constraints. Since memory usage in micro-ROS is a complex matter we provide a [complete article](https://micro-ros.github.io/docs/concepts/memo_prof/) describing it and a tutorial on [how to tune the memory consuption](https://micro-ros.github.io/docs/tutorials/core/microxrcedds_rmw_configuration/) in the micro-ROS middleware.
33+
The main targets of micro-ROS are mid-range 32-bits microcontroller families. Usually, the minimum requirements for running micro-ROS in an embedded platform are memory constraints. Since memory usage in micro-ROS is a complex matter we provide a [complete article](/docs/concepts/memo_prof/) describing it and a tutorial on [how to tune the memory consuption](https://micro-ros.github.io/docs/tutorials/core/microxrcedds_rmw_configuration/) in the micro-ROS middleware.
3434

3535
In general micro-ROS will need MCUs that have tens of kilobytes of RAM memory and communication peripherals that enable the micro-ROS [Client to Agent communication](https://micro-ros.github.io//docs/overview/features/).
3636

_includes/docs_nav.html

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,9 @@
1919
{% if page.path contains "_docs/concepts" and section.title == "Benchmarking" %}
2020
{% assign should_show_this_menu = true %}
2121
{% endif %}
22+
{% if page.path contains "_docs/concepts" and section.title == "Interoperability with FIWARE" %}
23+
{% assign should_show_this_menu = true %}
24+
{% endif %}
2225
{% if page.path contains "_docs/tutorials" and section.title contains "Tutorials" %}
2326
{% assign should_show_this_menu = true %}
2427
{% endif %}

0 commit comments

Comments
 (0)