diff --git a/doc/design/draft/draft.puml b/doc/design/draft/draft.puml new file mode 100644 index 00000000000..434a6b782a5 --- /dev/null +++ b/doc/design/draft/draft.puml @@ -0,0 +1,31 @@ +@startuml +object ProcessManager { + creates objects and + handles discovery +} +object ProcessAlice +object ProcessBob +object NodeSubscriber +object NodePublisher +object PublisherRadar +object PublisherVideo +object SubscriberRadar +object SubscriberVideo +object WaitSet +object Listener +object EventVariableA +object EventVariableB + +ProcessManager o-- ProcessAlice : <> +ProcessManager o-- ProcessBob : <> +ProcessBob "1" *-- "1..*" NodePublisher +NodeSubscriber "1" *-- "0..*" PublisherRadar +NodeSubscriber "1" *-- "0..*" PublisherVideo +ProcessAlice "1" *-- "1..*" NodeSubscriber +NodePublisher "1" *-- "0..*" SubscriberRadar +NodePublisher "1" *-- "0..*" SubscriberVideo +NodePublisher "1" *-- "0..*" WaitSet +NodePublisher "1" *-- "0..*" Listener +WaitSet "1" *-- "1" EventVariableA +Listener "1" *-- "1" EventVariableB +@enduml \ No newline at end of file diff --git a/doc/website/advanced/iceoryx_utils.md b/doc/website/advanced/iceoryx_utils.md index 624e91bc3f6..c41c847af55 100644 --- a/doc/website/advanced/iceoryx_utils.md +++ b/doc/website/advanced/iceoryx_utils.md @@ -1,4 +1,4 @@ --- title: Safe building blocks --- -{! ./../iceoryx_utils/README.md !} +{! ../iceoryx/iceoryx_utils/README.md !} diff --git a/doc/website/getting-started/examples/callbacks.md b/doc/website/getting-started/examples/callbacks.md index 909eed657b4..2a77f739595 100644 --- a/doc/website/getting-started/examples/callbacks.md +++ b/doc/website/getting-started/examples/callbacks.md @@ -2,4 +2,4 @@ title: Implementing event triggered callbacks using C++ --- -{! ./../iceoryx_examples/callbacks/README.md !} +{! ../iceoryx/iceoryx_examples/callbacks/README.md !} diff --git a/doc/website/getting-started/examples/callbacks_in_c.md b/doc/website/getting-started/examples/callbacks_in_c.md index 02488e43f48..5e2c09683fd 100644 --- a/doc/website/getting-started/examples/callbacks_in_c.md +++ b/doc/website/getting-started/examples/callbacks_in_c.md @@ -2,4 +2,4 @@ title: Implementing event triggered callbacks using C --- -{! ./../iceoryx_examples/callbacks_in_c/README.md !} +{! ../iceoryx/iceoryx_examples/callbacks_in_c/README.md !} diff --git a/doc/website/getting-started/examples/ice_access_control.md b/doc/website/getting-started/examples/ice_access_control.md index 80000a4f62e..0173839b93d 100644 --- a/doc/website/getting-started/examples/ice_access_control.md +++ b/doc/website/getting-started/examples/ice_access_control.md @@ -2,4 +2,4 @@ title: Configuring access rights for shared memory segments --- -{! ./../iceoryx_examples/ice_access_control/README.md !} +{! ../iceoryx/iceoryx_examples/ice_access_control/README.md !} diff --git a/doc/website/getting-started/examples/icecrystal.md b/doc/website/getting-started/examples/icecrystal.md index 315ab4cf876..4fb407e8824 100644 --- a/doc/website/getting-started/examples/icecrystal.md +++ b/doc/website/getting-started/examples/icecrystal.md @@ -2,4 +2,4 @@ title: Using the introspection client for debugging --- -{! ./../iceoryx_examples/icecrystal/Readme.md !} +{! ../iceoryx/iceoryx_examples/icecrystal/Readme.md !} diff --git a/doc/website/getting-started/examples/icedelivery.md b/doc/website/getting-started/examples/icedelivery.md index 8a3338dc87a..ff34f86f84c 100644 --- a/doc/website/getting-started/examples/icedelivery.md +++ b/doc/website/getting-started/examples/icedelivery.md @@ -2,4 +2,4 @@ title: Sending and receiving data using C++ --- -{! ./../iceoryx_examples/icedelivery/README.md !} +{! ../iceoryx/iceoryx_examples/icedelivery/README.md !} diff --git a/doc/website/getting-started/examples/icedelivery_in_c.md b/doc/website/getting-started/examples/icedelivery_in_c.md index fd6937610bc..248799db7ff 100644 --- a/doc/website/getting-started/examples/icedelivery_in_c.md +++ b/doc/website/getting-started/examples/icedelivery_in_c.md @@ -2,4 +2,4 @@ title: Sending and receiving data using C --- -{! ./../iceoryx_examples/icedelivery_in_c/README.md !} +{! ../iceoryx/iceoryx_examples/icedelivery_in_c/README.md !} diff --git a/doc/website/getting-started/examples/iceensemble.md b/doc/website/getting-started/examples/iceensemble.md index d94b8ac31bf..f988b7424e6 100644 --- a/doc/website/getting-started/examples/iceensemble.md +++ b/doc/website/getting-started/examples/iceensemble.md @@ -2,4 +2,4 @@ title: Using multiple publishers for one topic --- -{! ./../iceoryx_examples/iceensemble/README.md !} +{! ../iceoryx/iceoryx_examples/iceensemble/README.md !} diff --git a/doc/website/getting-started/examples/icehello.md b/doc/website/getting-started/examples/icehello.md index 51b28427d85..4c1681da66c 100644 --- a/doc/website/getting-started/examples/icehello.md +++ b/doc/website/getting-started/examples/icehello.md @@ -2,4 +2,4 @@ title: Sending data to another process --- -{! ./../iceoryx_examples/icehello/README.md !} +{! ../iceoryx/iceoryx_examples/icehello/README.md !} diff --git a/doc/website/getting-started/examples/iceoptions.md b/doc/website/getting-started/examples/iceoptions.md index 43af51db988..e12d65bb51c 100644 --- a/doc/website/getting-started/examples/iceoptions.md +++ b/doc/website/getting-started/examples/iceoptions.md @@ -2,4 +2,4 @@ title: Configuring pub/sub settings like history cache size or startup behaviour --- -{! ./../iceoryx_examples/iceoptions/README.md !} +{! ../iceoryx/iceoryx_examples/iceoptions/README.md !} diff --git a/doc/website/getting-started/examples/iceperf.md b/doc/website/getting-started/examples/iceperf.md index b557e169b5e..117d243b025 100644 --- a/doc/website/getting-started/examples/iceperf.md +++ b/doc/website/getting-started/examples/iceperf.md @@ -2,4 +2,4 @@ title: Measuring the latency of different IPC mechanisms --- -{! ./../iceoryx_examples/iceperf/README.md !} +{! ../iceoryx/iceoryx_examples/iceperf/README.md !} diff --git a/doc/website/getting-started/examples/index.md b/doc/website/getting-started/examples/index.md index 15969285334..7c077be205f 100644 --- a/doc/website/getting-started/examples/index.md +++ b/doc/website/getting-started/examples/index.md @@ -2,4 +2,4 @@ title: List of examples --- -{! ./../iceoryx_examples/README.md !} +{! ../iceoryx/iceoryx_examples/README.md !} diff --git a/doc/website/getting-started/examples/singleprocess.md b/doc/website/getting-started/examples/singleprocess.md index c4fc4551984..33a36d6804d 100644 --- a/doc/website/getting-started/examples/singleprocess.md +++ b/doc/website/getting-started/examples/singleprocess.md @@ -2,4 +2,4 @@ title: Communicating in a single process between threads --- -{! ./../iceoryx_examples/singleprocess/README.md !} +{! ../iceoryx/iceoryx_examples/singleprocess/README.md !} diff --git a/doc/website/getting-started/examples/waitset.md b/doc/website/getting-started/examples/waitset.md index 2a92f7b04db..025a2d00113 100644 --- a/doc/website/getting-started/examples/waitset.md +++ b/doc/website/getting-started/examples/waitset.md @@ -1,4 +1,4 @@ --- title: Waiting for events like arrival of data using C++ --- -{! ./../iceoryx_examples/waitset/README.md !} +{! ../iceoryx/iceoryx_examples/waitset/README.md !} diff --git a/doc/website/getting-started/examples/waitset_in_c.md b/doc/website/getting-started/examples/waitset_in_c.md index d611a7c9958..86179ce548c 100644 --- a/doc/website/getting-started/examples/waitset_in_c.md +++ b/doc/website/getting-started/examples/waitset_in_c.md @@ -2,4 +2,4 @@ title: Waiting for events like arrival of data using C --- -{! ./../iceoryx_examples/waitset_in_c/README.md !} +{! ../iceoryx/iceoryx_examples/waitset_in_c/README.md !} diff --git a/doc/website/index.md b/doc/website/index.md index a7bdaec1a05..be336d9e0ac 100644 --- a/doc/website/index.md +++ b/doc/website/index.md @@ -12,5 +12,5 @@ Eclipse iceoryxâ„¢ is a true zero-copy inter-process communication that allows v |

:octicons-stopwatch-16: Easy

|

:material-shield-half-full: Safe

|

:material-truck-fast: Fast

| |----|----|-----| -|||| +|||| |[Learn more](getting-started/what-is-iceoryx.md#easy){ .md-button }|[Learn more ](getting-started/what-is-iceoryx.md#safe){ .md-button }|[Learn more](getting-started/what-is-iceoryx.md#fast){ .md-button }|