Skip to content

Commit

Permalink
iox-#743 Set all docs links to latest
Browse files Browse the repository at this point in the history
Signed-off-by: Simon Hoinkis <[email protected]>
  • Loading branch information
mossmaurice committed Mar 14, 2022
1 parent 0696c01 commit 79c5fd2
Show file tree
Hide file tree
Showing 4 changed files with 7 additions and 7 deletions.
8 changes: 4 additions & 4 deletions QUALITY_DECLARATION.md
Original file line number Diff line number Diff line change
Expand Up @@ -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]

Expand Down Expand Up @@ -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.

Expand Down Expand Up @@ -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]

Expand Down
2 changes: 1 addition & 1 deletion iceoryx_examples/complexdata/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion iceoryx_examples/iceoptions/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/).

<!--[geoffrey][iceoryx_examples/iceoptions/iox_subscriber_with_options.cpp][history]-->
```cpp
Expand Down
2 changes: 1 addition & 1 deletion iceoryx_examples/request_response/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`.
Expand Down

0 comments on commit 79c5fd2

Please sign in to comment.