iox-#1295 (DROP ME) Rework examples, FAQ and config guide articles

Author: mossmaurice-apexai

doc/website/FAQ.md

@@ -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](../../iceoryx_examples/icedocker/)
+Yes. Take a look at the [icedocker example](examples/icedocker.md)
 
 ## iceoryx crashes with SIGABRT when reserving shared memory in a docker envirnonment
 
@@ -33,7 +33,7 @@ Either
 
 or
 
-* Use the [blocking publisher feature](../../iceoryx_examples/iceoptions/)
+* Use the [blocking publisher feature](examples/iceoptions.md)
 
 !!! caution
     The usage of the blocking publisher feature needs to be considered carefully as other subscribers will not receive
@@ -62,7 +62,7 @@ Possible solutions are one of the following:
 1. Increase [memory configuration of RouDi](advanced/configuration-guide.md)
 1. Make sure that the receiving frequency is higher than the publishing one
 1. Reduce `SubscriberOptions::queueCapacity` to hold less samples in the mempool on the subscriber side
-1. Consider using the [blocking publisher feature](../../iceoryx_examples/iceoptions/). The usage needs to be
+1. Consider using the [blocking publisher feature](examples/iceoptions.md). The usage needs to be
 considered carefully as other subscribers will not receive samples while the publisher is blocked.
 
 !!! caution
@@ -162,13 +162,13 @@ docker run -it --shm-size="2g" ubuntu
 To avoid undefined behavior of iceoryx posh it is recommended to terminate RouDi and the corresponding middleware
 processes with SIGINT or SIGTERM. In RouDi, we have integrated a sighandler that catches the signals and gives RouDi
 the chance to exit and clean-up everything. This also applies for processes. Therefore, we recommend adding a signalhandler
-to your process (see [this example](../../iceoryx_examples/icedelivery/iox_publisher_untyped.cpp)).
+to your process (see [this example](https://github.com/eclipse-iceoryx/iceoryx/blob/v3.0.0/iceoryx_examples/icedelivery/iox_publisher_untyped.cpp)).
 
 ## How to use iceoryx as external dependency with bazel
 
 Define iceoryx repository information in your [WORKSPACE](https://bazel.build/concepts/build-ref#workspace)
-then calling bazel macro from [load_repositories.bzl](https://github.com/eclipse-iceoryx/iceoryx/blob/main/bazel/load_repositories.bzl)
-and [setup_repositories.bzl](https://github.com/eclipse-iceoryx/iceoryx/blob/main/bazel/setup_repositories.bzl) for loading transitive dependencies.
+then calling bazel macro from [load_repositories.bzl](https://github.com/eclipse-iceoryx/iceoryx/blob/v3.0.0/bazel/load_repositories.bzl)
+and [setup_repositories.bzl](https://github.com/eclipse-iceoryx/iceoryx/blob/v3.0.0/bazel/setup_repositories.bzl) for loading transitive dependencies.
 
 ```
 load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")
@@ -188,5 +188,4 @@ load("@eclipse_iceoryx//bazel:load_repositories.bzl", "load_repositories")
 load("@eclipse_iceoryx//bazel:setup_repositories.bzl", "setup_repositories")
 load_repositories()
 setup_repositories()
-
 ```

doc/website/advanced/configuration-guide.md

@@ -21,8 +21,8 @@ in the shared memory segment called `iceoryx_mgmt` when RouDi is started.
  | `IOX_MAX_INTERFACE_NUMBER` | Maximum number of interface ports which are used by gateways |
  | `IOX_MAX_REQUESTS_PROCESSED_SIMULTANEOUSLY` | Maximum number of server can process request in parallel |
 
-Have a look at [IceoryxHoofsDeployment.cmake](../../../iceoryx_hoofs/cmake/IceoryxHoofsDeployment.cmake) and
-[IceoryxPoshDeployment.cmake](../../../iceoryx_posh/cmake/IceoryxPoshDeployment.cmake) for the default values of the constants.
+Have a look at [IceoryxHoofsDeployment.cmake](https://github.com/eclipse-iceoryx/iceoryx/blob/v3.0.0/iceoryx_hoofs/cmake/IceoryxHoofsDeployment.cmake) and
+[IceoryxPoshDeployment.cmake](https://github.com/eclipse-iceoryx/iceoryx/blob/v3.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
@@ -93,7 +93,7 @@ for communication.
     user-payload will be smaller than the configured chunk-payload since some
     space is needed for the other functionality.
     Please have a look at the
-    [chunk_header.md](../../design/chunk_header.md)
+    [chunk_header.md](https://github.com/eclipse-iceoryx/iceoryx/blob/v3.0.0/doc/design/chunk_header.md)
     design document for a formula how to determine the necessary chunk-payload
     size with user-header and extended user-payload alignment.
 
@@ -212,7 +212,7 @@ count = 100
 ```
 
 When no configuration file is specified a hard-coded version similar to the
-[default config](../../../iceoryx_posh/etc/iceoryx/roudi_config_example.toml)
+[default config](https://github.com/eclipse-iceoryx/iceoryx/blob/v3.0.0/iceoryx_posh/etc/iceoryx/roudi_config_example.toml)
 will be used.
 
 ### Static configuration
@@ -254,4 +254,4 @@ int main(int argc, char* argv[])
 ```
 
 A working example of a static config can be found
-[here](../../../iceoryx_examples/iceperf/roudi_main_static_config.cpp).
+[here](https://github.com/eclipse-iceoryx/iceoryx/blob/v3.0.0/iceoryx_examples/iceperf/roudi_main_static_config.cpp).

iceoryx_examples/callbacks/README.md

@@ -223,7 +223,7 @@ You just have to provide a reference to a value as additional argument in the `a
 which is then provided as argument in your callback. One of the use cases is to get access
 to members and methods of an object inside a static method which we demonstrate here.
 
-This example is identical to the [ice_callbacks_subscriber.cpp](#ice_callbacks_subscriber.cpp)
+This example is identical to the [ice_callbacks_subscriber.cpp](#ice_callbacks_subscribercpp)
 one, except that we left out the cyclic heartbeat trigger. The key difference is that
 the listener is now a class member and in every callback we would like to change
 some member variables. For this we require an additional pointer to the object

iceoryx_examples/callbacks_in_c/README.md

@@ -219,7 +219,7 @@ within the callback. To facilitate this we provide the functions called
 additional void pointer for the callback as second argument.
 
 The following example is a simplified version of the
-[ice_c_callbacks_subscriber.c](#ice_c_callbacks_subscriber.c) example where we
+[ice_c_callbacks_subscriber.c](#ice_c_callbacks_subscriberc) example where we
 removed the cyclic heartbeat trigger. The key difference is that we have
 a local variable called `counterService` in which we store the `leftCache`
 and `rightCache` and we let the callback update that variable directly.

iceoryx_examples/complexdata/README.md

@@ -4,8 +4,8 @@
 
 To implement zero-copy data transfer we use a shared memory approach. This requires that every data structure needs to be entirely
 contained in the shared memory and must not internally use pointers or references. The complete list of restrictions can be found
-[here](../../doc/website/getting-started/overview.md#restrictions). Therefore, most of the STL types cannot be used, but we
-reimplemented some [constructs](../../iceoryx_hoofs/README.md#cxx). This example shows how
+[here](../getting-started/overview.md#restrictions). Therefore, most of the STL types cannot be used, but we
+reimplemented some [constructs](../advanced/iceoryx_hoofs.md#cxx). This example shows how
 to send/receive a iox::vector and how to send/receive a complex data structure containing some of our STL container surrogates.
 
 ## Expected Output
@@ -63,7 +63,7 @@ for (const auto& entry : *sample)
 
 In this example our publisher will send a more complex data structure. It contains some of the STL containers that are reimplemented
 in iceoryx. A list of all reimplemented containers can be found
-[here](../../iceoryx_hoofs/README.md#cxx).
+[here](../advanced/iceoryx_hoofs.md#cxx).
 
 <!--[geoffrey][iceoryx_examples/complexdata/topic_data.hpp][complexdata type]-->
 ```cpp
@@ -116,7 +116,7 @@ handleInsertionReturnVal(sample->optionalList.push_front(iox::nullopt));
 
 !!! note
     If you're not familiar with `optional`, please have a look at
-    [How optional and error values are returned in iceoryx](../../doc/website/concepts/how-optional-and-error-values-are-returned-in-iceoryx.md#optional).
+    [How optional and error values are returned in iceoryx](../concepts/how-optional-and-error-values-are-returned-in-iceoryx.md#optional).
 
 Now we fill the stack
 

iceoryx_examples/icecrystal/Readme.md

@@ -17,7 +17,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/v3.0.0/tools/introspection).
 
 The introspection can be started with several command line arguments.
 

iceoryx_examples/icedelivery_in_c/README.md

@@ -1,7 +1,7 @@
 # icedelivery in C
 
 You can find a more detailed description of the C API in the
-[iceoryx_binding_c README.md](../../iceoryx_binding_c/README.md).
+[iceoryx_binding_c README.md](https://github.com/eclipse-iceoryx/iceoryx/blob/v3.0.0/iceoryx_binding_c/README.md).
 
 ## Introduction
 

iceoryx_examples/icediscovery/README.md

@@ -49,7 +49,7 @@ It is included via:
 ```
 
 On that object we can call the method `findService` which expects the three
-service [string identifiers](../../doc/website/getting-started/overview.md#creating-service-descriptions-for-topics)
+service [string identifiers](../getting-started/overview.md#creating-service-descriptions-for-topics)
 and a callable which will be applied to all matching services.
 In addition, we have to specify whether we want to search for publishers (`MessagingPattern::PUB_SUB`)
 used in publish-subscribe communication or servers (`MessagingPattern::REQ_RES`) used in

iceoryx_examples/request_response_in_c/README.md

@@ -1,7 +1,7 @@
 # Request response in C
 
 You can find a more detailed description of the C API in the
-[iceoryx_binding_c README.md](../../iceoryx_binding_c/README.md).
+[iceoryx_binding_c README.md](https://github.com/eclipse-iceoryx/iceoryx/blob/v3.0.0/iceoryx_binding_c/README.md).
 
 ## Introduction
 

iceoryx_examples/small_memory/README.md

@@ -5,7 +5,7 @@
 In some cases, it is needed to run iceoryx on systems with limited memory
 availability. For such cases, it is possible to configure the resource
 management limits as documented in the
-[configuration guide](../../doc/website/advanced/configuration-guide.md).
+[configuration guide](../advanced/configuration-guide.md).
 
 This configuration has two parts:
 * The resource limits set in cmake during configuration with options in the