Skip to content

Commit

Permalink
iox-#743 Fix several links
Browse files Browse the repository at this point in the history
Signed-off-by: Marika Lehmann <[email protected]>
  • Loading branch information
FerdinandSpitzschnueffler committed Mar 11, 2022
1 parent ad37027 commit 91dd909
Show file tree
Hide file tree
Showing 9 changed files with 12 additions and 11 deletions.
1 change: 0 additions & 1 deletion doc/website/.pages
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,3 @@ nav:
- FAQ.md
- advanced
- release-notes
- API-reference
2 changes: 1 addition & 1 deletion doc/website/FAQ.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ In this document are tips and hints documented which can help for troubleshootin

## Does iceoryx run in a docker environment

Yes. Take a look at the [icedocker example](https://github.com/eclipse-iceoryx/iceoryx/blob/v2.0.0/iceoryx_examples/icedelivery)
Yes. Take a look at the [icedocker example](https://github.com/eclipse-iceoryx/iceoryx/blob/v2.0.0/iceoryx_examples/icedocker)

## iox-roudi fails on startup

Expand Down
2 changes: 1 addition & 1 deletion doc/website/advanced/configuration-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ These options adjust the limits of Publisher and Subscriber Ports for resource m
| `IOX_MAX_CHUNKS_HELD_PER_SUBSCRIBER_SIMULTANEOUSLY` | Maximum number of chunks a subscriber can hold at a given time (subscriber history size)|
| `IOX_MAX_INTERFACE_NUMBER` | Maximum number of interface ports which are used for gateways |

Have a look at [iceoryx_posh_deployment.cmake](https://github.com/eclipse-iceoryx/iceoryx/blob/v2.0.0/iceoryx_posh/cmake/iceoryx_posh_deployment.cmake) for the default values of the constants.
Have a look at [IceoryxPoshDeployment.cmake](https://github.com/eclipse-iceoryx/iceoryx/blob/v2.0.0/iceoryx_posh/cmake/IceoryxPoshDeployment.cmake) for the default values of the constants.

!!! hint
With the default values set, the size of `iceoryx_mgmt` is ~64.5 MByte. You can reduce the size by decreasing the values from the table via the CMake options. The current values are printed in the CMake stage when building iceoryx.
Expand Down
2 changes: 1 addition & 1 deletion doc/website/examples/icediscovery_in_c.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@
title: Searching for currently available services using C
---

{! ../iceoryx/iceoryx_examples/icediscovery/README.md !}
{! ../iceoryx/iceoryx_examples/icediscovery_in_c/README.md !}
7 changes: 3 additions & 4 deletions doc/website/getting-started/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,9 +67,8 @@ iox::popo::Subscriber<CounterTopic> subscriber({"Group", "Instance", "CounterTop
```
Now we can use the subscriber to receive data. For simplicity, we assume that we periodically check for new data. It
is also possible to explicitly wait for data using the [WaitSet](https://github.com/eclipse-iceoryx/iceoryx/tree/v2.0.0/iceoryx_examples/waitset)
or the [Listener](https://github.com/eclipse-iceoryx/iceoryx/blob/v2.0.0/doc/design/listener.md). The code to
receive the data is the same, the only difference is the way we wake up before checking for data.
is also possible to explicitly wait for data using the [WaitSet](waitset.md) or the [Listener](callbacks.md). The
code to receive the data is the same, the only difference is the way we wake up before checking for data.
```cpp
while (keepRunning)
Expand Down Expand Up @@ -331,7 +330,7 @@ The API is offered in two languages, C++ and C. Detailed information can be foun

Many parts of the C++ API follow a functional programming approach which is less error-prone. This requires using
the monadic types `cxx::expected` and `cxx::optional` which are introduced
[here](https://github.com/eclipse-iceoryx/iceoryx/blob/v2.0.0/doc/website/concepts/how-optional-and-error-values-are-returned-in-iceoryx.md).
[here](how-optional-and-error-values-are-returned-in-iceoryx.md).

With the C++ API, we distinguish between the `typed API` and the `untyped API`. In the typed API, the underlying
data type is made apparent by typed pointers or references to some data type T (often a template parameter). This allows
Expand Down
2 changes: 1 addition & 1 deletion iceoryx_examples/icecrystal/Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ We re-use the binaries from
## Feature walkthrough

This example does not contain any additional code. The code of the `iceoryx_introspection_client` can be found under
[tools/introspection/](../../tools/introspection/).
[tools/introspection/](https://github.com/eclipse-iceoryx/iceoryx/tree/v2.0.0/tools/introspection).

The introspection can be started with several command line arguments.

Expand Down
2 changes: 1 addition & 1 deletion iceoryx_examples/icediscovery/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ default. For more dynamism the `cameraPublishers` offer/stop their services
periodically. If you want more information on how to create a publisher, have a
look at the [icehello](https://github.com/eclipse-iceoryx/iceoryx/tree/v2.0.0/iceoryx_examples/icehello),
[icedelivery](https://github.com/eclipse-iceoryx/iceoryx/tree/v2.0.0/iceoryx_examples/icedelivery),
and [iceoptions](https://github.com/eclipse-iceoryx/iceoryx/tree/v2.0.0/iceoryx_examples/icedelivery)
and [iceoptions](https://github.com/eclipse-iceoryx/iceoryx/tree/v2.0.0/iceoryx_examples/iceoptions)
examples.

### Find services
Expand Down
2 changes: 1 addition & 1 deletion iceoryx_examples/icediscovery_in_c/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
This example demonstrates how to search for specific services using iceoryx's
service discovery. It provides two applications - one offering different
services and one searching for those with different search queries. The
behavior and structure is quite similar to the [icediscovery C++ example](https://github.com/eclipse-iceoryx/iceoryx/tree/v2.0.0/iceoryx_examples/icedelivery).
behavior and structure is quite similar to the [icediscovery C++ example](https://github.com/eclipse-iceoryx/iceoryx/tree/v2.0.0/iceoryx_examples/icediscovery).

<!--## Expected Output-->
<!-- @todo Add expected output with asciinema recording before v2.0-->
Expand Down
3 changes: 3 additions & 0 deletions iceoryx_examples/user_header/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -295,3 +295,6 @@ if (iox_sub_take_chunk(subscriber, &userPayload) == ChunkReceiveResult_SUCCESS)
iox_sub_release_chunk(subscriber, userPayload);
}
```
<center>
[Check out User-Header on GitHub :fontawesome-brands-github:](https://github.com/eclipse-iceoryx/iceoryx/tree/v2.0.0/iceoryx_examples/user_header){ .md-button }
</center>

0 comments on commit 91dd909

Please sign in to comment.