Release validation for v3.0

[mossmaurice]

Website/Markdown settings

• Add .markdownlint.yaml file Moved to Release validation for v4.0 #2403
• Check Keys and annotations features
• split images into a root folder with common images and one for the specific versions for the rendered SVGs Moved to Release validation for v4.0 #2403
• update footer according to the new landing page
  • copyright
  • vertical social media links
  • improved logos
• adapt script for new landing page -> Only index.html was changed, which is not updated by the script tools/website/export-docu-to-website.sh

Common

• Update architecture diagrams
• Revise doc/website/getting-started/installation.md
• Revise tools/website/how-to-record-asciicast.md
• Write down questions that came up before in FAQ.md
• Decision whether to remove the QAC Helix guide (Can this be maintained by Perforce?) tools/HelixQAC/README.md
• Add integration hints to other platforms
• Add separator for the API change sections
• icedelivery: Explain lifetime semantics of chunks/samples and user restrictions: loan needs to be followed with publish or release, MAX_CHUNKS_IN_USE on publisher and subscriber side etc., API is not thread-safe, update asciinema record (@MatthiasKillat) Moved to Release validation for v4.0 #2403
• Add Apex.AI logo in .svg

Examples

• Rework icediscovery example Moved to Release validation for v4.0 #2403
• Fix broken example SingleProcess on Windows Fixed in Crashes due to increased stack size requirements #1082

Update

• Update installation-guide-for-contributors.md article

New articles

• Add binding/extension article about Rust, ara::com and DDS Gateway
  • Update iceoryx_components_diagram_nextgen_release.puml e.g. removing DDS Gateway
• How to write integration tests Moved to Release validation for v4.0 #2403
• Performance results section Moved to Release validation for v4.0 #2403
• Add an article which describes den command line parameters of RouDi
• Add new article describing the long-term goals of iceoryx2 and the transition strategy from the user perspective

Release note

• Add entry about clang-tidy and AUTOSAR warning fixes
• Cherry-pick v2.x.y release notes to main branch

Last tasks

• Re-record all changed asciinema recordings Not necessary for only non-functional RouDi changes
  • posix wrapper should be silent on success #971 changed the output of all iox-roudi recordings, maybe record roudi startup only once to avoid to record all examples when the roudi output changes.

[elBoberido]

Thanks creating this issue. Regarding the new articles. I think the last release showed that there most probably is no time for new articles so close to the release. Maybe we can concentrate earlier on this articles and then just need to proof read them during release validation. Maybe we should take some time in a developer meetup to talk about our release procedure and when we want to enforce which freezes, e.g. soft feature freeze, feature freeze, documentation freeze, dependency freeze, etc.

[mossmaurice]

@elBoberido

[ ] Add new article describing the long-term goals of iceoryx2 and the transition strategy from the user perspective

Do you think this is necessary to add to the iceoryx classic documentation? My feeling is this belongs more to the iceoryx2 docs which then also comes with some examples and maybe clang-tidy rules to refactor C++ code to move from iceoryx classic to the iceoryx2 C++ binding. Short-term this could also be added to the index.html.