Merge pull request #735 from ApexAI/iox-#482-three-pillars

iox-#482 three pillars for website

CHANGELOG.md

@@ -1,8 +1,8 @@
 # Change Log
 
-## [v1.0.0](https://github.com/eclipse-iceoryx/iceoryx/tree/v1.0.0) (2021-04-30)
+## [v1.0.0](https://github.com/eclipse-iceoryx/iceoryx/tree/v1.0.0) (2021-04-15)
 
-[Full Changelog](https://github.com/eclipse-iceoryx/iceoryx/compare/v0.90.0...v1.0.0)
+[Full Changelog](https://github.com/eclipse-iceoryx/iceoryx/compare/v0.90.7...v1.0.0)
 
 Description:
 This is the first major release for Eclipse iceoryx. That means it is the first release with long-term support and the adopters of iceoryx can rely on a stable API. The release called Almond allows for true zero-copy inter-process-communication on Linux, QNX and MacOS and provides C and modern C++ user APIs. This release is supported until 2022-04-01.

VERSION

@@ -1 +1 @@
-0.99.7
+1.0.0

cmake/package/package.cmake

@@ -14,7 +14,7 @@
 #
 # SPDX-License-Identifier: Apache-2.0
 cmake_minimum_required(VERSION 3.5)
-set(IOX_VERSION_STRING "0.99.7")
+set(IOX_VERSION_STRING "1.0.0")
 
 project(iceoryx_package VERSION ${IOX_VERSION_STRING})
 

doc/aspice_swe3_4/CMakeLists.txt

@@ -16,7 +16,7 @@
 
 cmake_minimum_required(VERSION 3.10)
 
-set(IOX_VERSION_STRING "0.99.7")
+set(IOX_VERSION_STRING "1.0.0")
 
 #find_package(iceoryx_utils REQUIRED)
 

doc/website/getting-started/what-is-iceoryx.md

@@ -1 +1,64 @@
 # What is Eclipse iceoryx?
+
+The technology behind Eclipse iceoryx originated in the automotive domain. With the introduction of video-based driver
+assistance, the amount of data to be exchanged between different threads of execution increased to GBytes/sec. The
+resources on these embedded systems were constrained and a solution was needed to use precious runtime for functional
+computations, not for shifting around bytes in memory.
+
+The simple answer was to avoid copying of messages inside the middleware that manages the data communication between
+the different software nodes. This can be done by using shared memory that can be accessed by the producers and
+consumers of messages. On its own, this is not a new innovation as the approach has been used since the 1970s.
+However, iceoryx takes the approach further, ending up in an inter-process-communication technology with a
+publish/subscribe architecture that is fast, flexible and dependable.
+
+
+## Fast
+
+With the iceoryx API, a publisher can write the message directly into a chunk of memory that was previously requested
+from the middleware. When the message is delivered, subscribers receive reference counted pointers to these memory
+chunks, which are stored in queues with configurable capacities. With this iceoryx achieves what we refer to as true
+zero-copy — an end-to-end approach from publishers to subscribers without creating a single copy.
+
+Avoiding the copies on API level is crucial when GBytes of sensor data have to be processed per second on robotics and
+autonomous driving systems. Therefore the iceoryx team contributed to the standardization of true zero-copy capable
+APIs in [ROS 2](https://www.ros.org/) and [AUTOSAR Adaptive](https://www.autosar.org/standards/adaptive-platform/). 
+
+On modern processors iceoryx has a latency of less than 1 µs for transferring a message. And the best message is that
+this latency is constant as size doesn't matter. Want to give it a try? Then have a look at our
+[iceperf example](../examples/iceperf) after having made the first steps. 
+
+## Flexible
+
+iceoryx already supports Linux, QNX and MacOS as operating systems as well as C and C++ as user APIs. Windows and Rust
+are the next ones on the list. The typed C++ API is the most comfortable when you want to directly use the iceoryx API
+on the user side. The untyped C++ API and the C API provide a data agnostic interface that is often preferred when
+integrating iceoryx as shared memory backbone into a bigger framework.
+
+The APIs support polling access and event-driven interactions with the [Waitset](../overview/#waitset) and
+[Listener](../overview/#listener). Applications can be started and stopped flexibly as there is a service discovery
+behind the scenes that dynamically connects matching communication entities. 
+
+That iceoryx has the right set of features can be seen from the already existing integrations in middleware and
+frameworks such as [Eclipse Cyclone DDS](https://github.com/eclipse-cyclonedds/cyclonedds),
+ [eCAL from Continental](https://continental.github.io/ecal/),
+ [RTA-VRTE from ETAS](https://www.etas.com/en/products/rta-vrte.php) and
+ [Apex.OS from Apex.AI](https://www.apex.ai/apex-os).  
+
+## Dependable
+
+The predecessor of iceoryx is running in millions of vehicles worldwide. All iceoryx maintainers hail from the
+safety critical automotive domain. Hence, they know the necessary requirements and have these in mind for the
+design and implementation of features. The usage of heap, exceptions and any undefined behavior are to be avoided
+to increase the predictability. Instead a custom memory allocation is being used, based on static memory pools.
+Additionally, the handling of return values and error cases was inspired by upcoming C++ features and other
+languages like Rust (details can be found
+[here](../../advanced/how-optional-and-error-values-are-returned-in-iceoryx/)).
+
+As different processes are operating on shared data structures, avoiding deadlocks is becoming all the more important.
+iceoryx uses look-free data structures like the multi-producer multi-consumer (MPMC) queue that was written portably
+thanks to modern C++.  
+
+The tools available for automotive-compliant software development are always one or two releases behind the latest C++
+standard. This fact, combined with our already mentioned constraints, led to a bunch of STL like C++ classes that have
+the goal to combine modern C++ with the reliability needed for the domains iceoryx is used in. They can be found in
+the iceoryx utils which are introduced [here](../../advanced/iceoryx_utils/)

doc/website/index.md

@@ -8,9 +8,9 @@ title: Home
         width="50%">
 </p>
 
-Eclipse iceoryx™ is a true zero-copy inter-process communication that allows virtually limitless data transfer at constant time.
+Eclipse iceoryx™ is an inter-process-communication midddleware that enables virtually limitless data transmissions at constant time.
 
-| <h2>:octicons-stopwatch-16: Easy</h2> | <h2>:material-shield-half-full: Safe</h2> | <h2>:material-truck-fast: Fast</h2> |
+| <h2>:material-truck-fast: Fast</h2> | <h2>::material-puzzle: Flexible</h2> | <h2>:material-shield-half-full: Dependable</h2> |
 |----|----|-----|
-|<ul><li>Simple publish-subscribe API with service discovery</li><li>Straightforward usage for ROS2 and Adaptive AUTOSAR</li><li>Runs on QNX, Linux, MacOS and Windows</li></ul>|<ul><li>Automotive-grade (ISO26262 certification ongoing)</li><li>Lock-free algorithms prevent deadlocks</li><li>Huge library with safe STL implementations</li></ul>|<ul><li>Written in C++14</li><li>C binding available</li><li>Zero-copy data transmission with shared memory</li><li>Ultra low latency</li></ul>|
-|[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 }|
+|<ul><li>True zero-copy shared memory communication</li><li>Message transfers with a latency of less than 1 µs</li><li>Made to handle GBytes/sec data transfers</li></ul>|<ul><li>Support of various operating systems, communication patterns and APIs</li><li>Service discovery enables the design of dynamic systems</li><li>Easy to integrate into frameworks like ROS 2 or AUTOSAR Adaptive</li></ul>|<ul><li>Developed according to automotive requirements</li><li>Implementation based on static memory and lock-free algorithms</li><li>Huge C++ library with safe STL implementations</li></ul>|
+|[Learn more](getting-started/what-is-iceoryx.md#fast){ .md-button }|[Learn more ](getting-started/what-is-iceoryx.md#flexible){ .md-button }|[Learn more](getting-started/what-is-iceoryx.md#dependable){ .md-button }|

iceoryx_binding_c/CMakeLists.txt

@@ -16,7 +16,7 @@
 # SPDX-License-Identifier: Apache-2.0
 cmake_minimum_required(VERSION 3.7)
 
-set(IOX_VERSION_STRING "0.99.7")
+set(IOX_VERSION_STRING "1.0.0")
 
 
 

iceoryx_binding_c/package.xml

@@ -2,7 +2,7 @@
 <?xml-model href="http://download.ros.org/schema/package_format3.xsd" schematypens="http://www.w3.org/2001/XMLSchema"?>
 <package format="3">
     <name>iceoryx_binding_c</name>
-    <version>0.99.7</version>
+    <version>1.0.0</version>
     <description>Eclipse iceoryx inter-process-communication (IPC) middleware C-Language Binding</description>
     <maintainer email="[email protected]">Eclipse Foundation, Inc.</maintainer>
     <license>Apache 2.0</license>

iceoryx_dds/CMakeLists.txt

@@ -16,7 +16,7 @@
 # SPDX-License-Identifier: Apache-2.0
 cmake_minimum_required(VERSION 3.7)
 
-set(IOX_VERSION_STRING "0.99.7")
+set(IOX_VERSION_STRING "1.0.0")
 
 project(iceoryx_dds VERSION ${IOX_VERSION_STRING})
 

iceoryx_integrationtest/package.xml

@@ -2,7 +2,7 @@
 <?xml-model href="http://download.ros.org/schema/package_format3.xsd" schematypens="http://www.w3.org/2001/XMLSchema"?>
 <package format="3">
   <name>iceoryx_integrationtest</name>
-  <version>0.99.7</version>
+  <version>1.0.0</version>
   <description>iceoryx Software Integrationtest</description>
     <maintainer email="[email protected]">Eclipse Foundation, Inc.</maintainer>
     <license>Apache 2.0</license>

iceoryx_posh/CMakeLists.txt

@@ -16,7 +16,7 @@
 # SPDX-License-Identifier: Apache-2.0
 cmake_minimum_required(VERSION 3.5)
 
-set(IOX_VERSION_STRING "0.99.7")
+set(IOX_VERSION_STRING "1.0.0")
 
 project(iceoryx_posh VERSION ${IOX_VERSION_STRING})
 

iceoryx_posh/package.xml

@@ -2,7 +2,7 @@
 <?xml-model href="http://download.ros.org/schema/package_format3.xsd" schematypens="http://www.w3.org/2001/XMLSchema"?>
 <package format="3">
     <name>iceoryx_posh</name>
-    <version>0.99.7</version>
+    <version>1.0.0</version>
     <description>Eclipse iceoryx inter-process-communication (IPC) middleware Posix Shared Memory Library and middleware daemon (RouDi)</description>
     <maintainer email="[email protected]">Eclipse Foundation, Inc.</maintainer>
     <license>Apache 2.0</license>

iceoryx_utils/CMakeLists.txt

@@ -17,7 +17,7 @@
 
 cmake_minimum_required(VERSION 3.5)
 
-set(IOX_VERSION_STRING "0.99.7")
+set(IOX_VERSION_STRING "1.0.0")
 
 
 #include("${CMAKE_CURRENT_LIST_DIR}/cmake/IceoryxVersion.cmake")

iceoryx_utils/package.xml

@@ -2,7 +2,7 @@
 <?xml-model href="http://download.ros.org/schema/package_format3.xsd" schematypens="http://www.w3.org/2001/XMLSchema"?>
 <package format="3">
     <name>iceoryx_utils</name>
-    <version>0.99.7</version>
+    <version>1.0.0</version>
     <description>Eclipse iceoryx inter-process-communication (IPC) middleware basic building blocks</description>
     <maintainer email="[email protected]">Eclipse Foundation, Inc.</maintainer>
     <license>Apache 2.0</license>

tools/introspection/CMakeLists.txt

@@ -17,7 +17,7 @@
 
 cmake_minimum_required(VERSION 3.5)
 
-set(IOX_VERSION_STRING "0.99.7")
+set(IOX_VERSION_STRING "1.0.0")
 
 project(iceoryx_introspection VERSION ${IOX_VERSION_STRING})