diff --git a/QUALITY_DECLARATION.md b/QUALITY_DECLARATION.md index 7419975696..141726d85f 100644 --- a/QUALITY_DECLARATION.md +++ b/QUALITY_DECLARATION.md @@ -23,7 +23,7 @@ On Git, the tags have a `v` prefix before the version numbers. A [release script Since release `1.0.0` iceoryx is at a stable version, i.e. `>= 1.0.0`. The latest valid release can be found on the [release page](https://github.com/eclipse-iceoryx/iceoryx/releases) of iceoryx. -The change history can be found in the [release notes section](https://iceoryx.io/v2.0.0/release-notes). +The change history can be found in the [release notes section](https://iceoryx.io/latest/release-notes). ### Public API Declaration [1.iii] @@ -89,8 +89,8 @@ It is required to create/modify the Doxygen/design and user documentation within ### Feature Documentation [3.i] -The documentation of the main iceoryx features (sending, receiving data) can be found in the [overview](https://iceoryx.io/v2.0.0/getting-started/overview/) and [iceoryx examples](https://iceoryx.io/v2.0.0/getting-started/examples/) including a user-friendly description on how to use the iceoryx API. -The [configuration guide](https://iceoryx.io/v2.0.0/advanced/configuration-guide/) completes the documentation on how to use iceoryx. +The documentation of the main iceoryx features (sending, receiving data) can be found in the [overview](https://iceoryx.io/latest/getting-started/overview/) and [iceoryx examples](https://iceoryx.io/latest/getting-started/examples/) including a user-friendly description on how to use the iceoryx API. +The [configuration guide](https://iceoryx.io/latest/advanced/configuration-guide/) completes the documentation on how to use iceoryx. Detailed technical documentation about iceoryx features can be found in the [design document](https://github.com/eclipse-iceoryx/iceoryx/tree/master/doc/design) section with descriptions and diagrams about internal mechanisms of iceoryx. @@ -131,7 +131,7 @@ There is continuous effort to cover the corner cases in the usage of iceoryx in ### Public API Testing [4.ii] All tests are executed for every major feature. New features must provide unit and integration tests that cover the code changes in the Pull-Request. The tests reside in separated folders for every package following a defined structure and naming convention. -The features are tested at module(unit) -integration and system test level. The [guidelines](https://iceoryx.io/v2.0.0/advanced/best-practice-for-testing/) for Contributors ensure a high quality of test development. +The features are tested at module(unit) -integration and system test level. The [guidelines](https://iceoryx.io/latest/advanced/best-practice-for-testing/) for Contributors ensure a high quality of test development. ### Coverage [4.iii] diff --git a/iceoryx_examples/complexdata/README.md b/iceoryx_examples/complexdata/README.md index cfaa5eeefa..63891fd60a 100644 --- a/iceoryx_examples/complexdata/README.md +++ b/iceoryx_examples/complexdata/README.md @@ -4,7 +4,7 @@ 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](https://iceoryx.io/v2.0.0/getting-started/overview/#restrictions). Therefore, most of the STL types cannot be used, but we +[here](https://iceoryx.io/latest/getting-started/overview/#restrictions). Therefore, most of the STL types cannot be used, but we reimplemented some [constructs](https://github.com/eclipse-iceoryx/iceoryx/tree/master/iceoryx_hoofs#cxx). This example shows how to send/receive a iox::cxx::vector and how to send/receive a complex data structure containing some of our STL container surrogates. diff --git a/iceoryx_examples/iceoptions/README.md b/iceoryx_examples/iceoptions/README.md index 4e904e3ecc..ba41c1f0ef 100644 --- a/iceoryx_examples/iceoptions/README.md +++ b/iceoryx_examples/iceoptions/README.md @@ -97,7 +97,7 @@ By default this is set to `false` and best-effort behavior is used. !!! warning In case of n:m communication, the history feature will **not** provide the overall last n samples based on delivery point in time! - For more information about this limitation see the [QoS article](https://iceoryx.io/v2.0.0/concepts/qos-policies/). + For more information about this limitation see the [QoS article](https://iceoryx.io/latest/concepts/qos-policies/). ```cpp diff --git a/iceoryx_examples/request_response/README.md b/iceoryx_examples/request_response/README.md index 92ab4342b9..3023db5751 100644 --- a/iceoryx_examples/request_response/README.md +++ b/iceoryx_examples/request_response/README.md @@ -63,7 +63,7 @@ iox::runtime::PoshRuntime::initRuntime(APP_NAME); ``` After creating the runtime, the client is created and attached to the WaitSet. -The [options](https://iceoryx.io/v2.0.0/getting-started/examples/iceoptions/) can be used to alter the behavior of the client, like setting the response +The [options](https://iceoryx.io/latest/getting-started/examples/iceoptions/) can be used to alter the behavior of the client, like setting the response queue capacity or blocking behavior when the response queue is full or the server is too slow. The `ClientOptions` are similar to `PublisherOptions`/`SubscriberOptions`.