Release validation for `v3.0`

[mossmaurice]

Website/Markdown settings

• [ ] Add .markdownlint.yaml file
• [ ] Check Keys and annotations features
• [ ] move fonts to the root folder and symlink them from everywhere else
  • [ ] explore whether the same can be done with the assets
• [ ] split images into a root folder with common images and one for the specific versions for the rendered SVGs
• [ ] update footer according to the new landing page
  • [ ] copyright
  • [ ] vertical social media links
  • [ ] improved logos
• [ ] adapt script for new landing page

Common

• [x] Update architecture diagrams
• [ ] Revise doc/website/getting-started/installation.md
• [ ] Revise tools/website/how-to-record-asciicast.md
• [x] Write down questions that came up before in FAQ.md
• [x] 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)
• [ ] Add Apex.AI logo in .svg

Examples

• [ ] Rework icediscovery example
• [ ] Fix broken example SingleProcess on Windows

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
• [ ] Performance results section
• [ ] 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

Last tasks

• [ ] Re-record all changed asciinema recordings

  • 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.

[elBoberido]

@mossmaurice I guess this can be reopened?

[mossmaurice]

@elBoberido

Everything seems up-to-date and sensible to address as part of the v3.0 C-release besides:

How to write integration tests Performance results section Add an article which describes den command line parameters of RouDi

I think for the sake of time we can skip those new articles and address them with v4.0.

My proposal regarding iceoryx2 is to add a hint on the landing page and describe the long-term goals and transition strategy (that's what's most relevant to the user in a separate article under "Advanced"). From this article we can also link to https://docs.rs/iceoryx2/latest/iceoryx2/

Meanwhile, I would whatever our future plans will be, open an issue in the Eclipse Gitlab to reserve iceoryx.rs before someone else does :wink:

Does that make sense to you?

[elBoberido]

@mossmaurice yes, sounds good.

The articles are also one of the reasons I would like to decouple the website from the tags. This gives us more freedom and we can just tag the articles for which version they are relevant.