Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Release validation for v3.0 #1295

Open
5 of 30 tasks
mossmaurice opened this issue Mar 17, 2022 · 4 comments · Fixed by #1296, #1219, #1434 or #1600 · May be fixed by #2398
Open
5 of 30 tasks

Release validation for v3.0 #1295

mossmaurice opened this issue Mar 17, 2022 · 4 comments · Fixed by #1296, #1219, #1434 or #1600 · May be fixed by #2398
Assignees
@mossmaurice
Labels
documentation Improvements or additions to documentation

Comments

@mossmaurice
Copy link
Contributor

mossmaurice commented Mar 17, 2022 •
edited
Loading

Website/Markdown settings

  • Add .markdownlint.yaml file -> Moved to Release validation for v4.0 #2403
  • 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

  • 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)
  • 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
@mossmaurice mossmaurice added the documentation Improvements or additions to documentation label Mar 17, 2022
@mossmaurice mossmaurice mentioned this issue Mar 17, 2022
Closed
53 tasks
mossmaurice added a commit to ApexAI/iceoryx that referenced this issue Mar 17, 2022
@mossmaurice
iox-eclipse-iceoryx#1295 Fix a link and a typo in the request respons…
4ac450a 
…e example

Signed-off-by: Simon Hoinkis <[email protected]>
This was referenced Mar 17, 2022
Merged
Merged
@elBoberido
Copy link
Member

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 added a commit that referenced this issue Mar 18, 2022
@mossmaurice
Merge pull request #1296 from ApexAI/iox-#1295-fix-request-response-e…
eb51e64 
…xample

iox-#1295 Fix request response example
@elBoberido elBoberido reopened this Mar 18, 2022
mossmaurice added a commit to ApexAI/iceoryx that referenced this issue Mar 28, 2022
@mossmaurice
iox-eclipse-iceoryx#1295 Extend FAQ article
a04626e 
Signed-off-by: Simon Hoinkis <[email protected]>
mossmaurice added a commit to ApexAI/iceoryx that referenced this issue Mar 29, 2022
@mossmaurice
iox-eclipse-iceoryx#1295 Fix typos, line length and rename 'Image' Ev…
90c4945 
…entId to 'Objects' for Radar service

Signed-off-by: Simon Hoinkis <[email protected]>
mossmaurice added a commit to ApexAI/iceoryx that referenced this issue Mar 29, 2022
@mossmaurice
iox-eclipse-iceoryx#1295 Adapt icediscovery integration test to renam…
f13b500 
…ing of topic

Signed-off-by: Simon Hoinkis <[email protected]>
mossmaurice added a commit to ApexAI/iceoryx that referenced this issue Mar 29, 2022
@mossmaurice
iox-eclipse-iceoryx#1295 Rename executables of icediscovery
20083c4 
Signed-off-by: Simon Hoinkis <[email protected]>
mossmaurice added a commit to ApexAI/iceoryx that referenced this issue Mar 29, 2022
@mossmaurice
iox-eclipse-iceoryx#1295 Update related icediscovery_in_c example acc…
6fe964b 
…ordingly

Signed-off-by: Simon Hoinkis <[email protected]>
mossmaurice added a commit to ApexAI/iceoryx that referenced this issue Mar 29, 2022
@mossmaurice
iox-eclipse-iceoryx#1295 Update related icediscovery_in_c example acc…
dca8c4d 
…ordingly

Signed-off-by: Simon Hoinkis <[email protected]>
mossmaurice added a commit to ApexAI/iceoryx that referenced this issue Mar 30, 2022
@mossmaurice
iox-eclipse-iceoryx#1295 Update related icediscovery_in_c example acc…
807fb97 
…ordingly

Signed-off-by: Simon Hoinkis <[email protected]>
mossmaurice added a commit to ApexAI/iceoryx that referenced this issue Mar 30, 2022
@mossmaurice
iox-eclipse-iceoryx#1295 Update related icediscovery_in_c example acc…
4d018c8 
…ordingly

Signed-off-by: Simon Hoinkis <[email protected]>
mossmaurice added a commit to ApexAI/iceoryx that referenced this issue Mar 30, 2022
@mossmaurice
iox-eclipse-iceoryx#1295 Update related icediscovery_in_c example acc…
cd6e531 
…ordingly

Signed-off-by: Simon Hoinkis <[email protected]>
mossmaurice added a commit to ApexAI/iceoryx that referenced this issue Mar 30, 2022
@mossmaurice
iox-eclipse-iceoryx#1295 Fix typos, line length and rename 'Image' Ev…
f6663d2 
…entId to 'Objects' for Radar service

Signed-off-by: Simon Hoinkis <[email protected]>
mossmaurice added a commit to ApexAI/iceoryx that referenced this issue Mar 30, 2022
@mossmaurice
iox-eclipse-iceoryx#1295 Adapt icediscovery integration test to renam…
ed80732 
…ing of topic

Signed-off-by: Simon Hoinkis <[email protected]>
mossmaurice added a commit to ApexAI/iceoryx that referenced this issue Mar 30, 2022
@mossmaurice
iox-eclipse-iceoryx#1295 Rename executables of icediscovery
7a9bea1 
Signed-off-by: Simon Hoinkis <[email protected]>
mossmaurice added a commit to ApexAI/iceoryx that referenced this issue Mar 30, 2022
@mossmaurice
iox-eclipse-iceoryx#1295 Update related icediscovery_in_c example acc…
117086e 
…ordingly

Signed-off-by: Simon Hoinkis <[email protected]>
mossmaurice added a commit to ApexAI/iceoryx that referenced this issue Apr 4, 2022
@mossmaurice
iox-eclipse-iceoryx#1295 Comment out outdated asciicasts
677bb5a 
Signed-off-by: Simon Hoinkis <[email protected]>
mossmaurice added a commit that referenced this issue Apr 11, 2022
@mossmaurice
Merge pull request #1219 from ApexAI/iox-#743-rework-icediscovery-exa…
44f1dbc 
…mple

iox-#1295 Rework `icediscovery` example
@elBoberido elBoberido reopened this Apr 11, 2022
elfenpiff pushed a commit to ApexAI/iceoryx that referenced this issue Apr 12, 2022
@mossmaurice @elfenpiff
iox-eclipse-iceoryx#1295 Fix typos, line length and rename 'Image' Ev…
768d7b6 
…entId to 'Objects' for Radar service

Signed-off-by: Simon Hoinkis <[email protected]>
elfenpiff pushed a commit to ApexAI/iceoryx that referenced this issue Apr 12, 2022
@mossmaurice @elfenpiff
iox-eclipse-iceoryx#1295 Adapt icediscovery integration test to renam…
38c57c7 
…ing of topic

Signed-off-by: Simon Hoinkis <[email protected]>
elfenpiff pushed a commit to ApexAI/iceoryx that referenced this issue Apr 12, 2022
@mossmaurice @elfenpiff
iox-eclipse-iceoryx#1295 Rename executables of icediscovery
a19d214 
Signed-off-by: Simon Hoinkis <[email protected]>
elfenpiff pushed a commit to ApexAI/iceoryx that referenced this issue Apr 12, 2022
@mossmaurice @elfenpiff
iox-eclipse-iceoryx#1295 Update related icediscovery_in_c example acc…
e177a1f 
…ordingly

Signed-off-by: Simon Hoinkis <[email protected]>
@mossmaurice mossmaurice mentioned this issue Apr 8, 2024
Merged
elBoberido added a commit to elBoberido/iceoryx that referenced this issue Jul 5, 2024
@elBoberido
iox-eclipse-iceoryx#1295 Bump version to 2.95.0
b1102de
@elBoberido elBoberido mentioned this issue Jul 5, 2024
Merged
21 tasks
elBoberido added a commit that referenced this issue Jul 5, 2024
@elBoberido
Merge pull request #2313 from elBoberido/iox-1295-bump-version-to-2.95.0
d984660 
iox-#1295 Bump version to 2.95.0
elBoberido added a commit to elBoberido/iceoryx that referenced this issue Jul 5, 2024
@elBoberido
iox-eclipse-iceoryx#1295 Make iceoryx version available for in-tree b…
3157277 
…uilds
elBoberido added a commit to elBoberido/iceoryx that referenced this issue Jul 5, 2024
@elBoberido
iox-eclipse-iceoryx#1295 Make iceoryx version available for in-tree b…
7a18e86 
…uilds
elBoberido added a commit to elBoberido/iceoryx that referenced this issue Jul 5, 2024
@elBoberido
iox-eclipse-iceoryx#1295 Make iceoryx version available for in-tree b…
e6507f4 
…uilds
elBoberido added a commit to elBoberido/iceoryx that referenced this issue Jul 5, 2024
@elBoberido
iox-eclipse-iceoryx#1295 Make iceoryx version available for in-tree b…
81e5447 
…uilds
@elBoberido elBoberido mentioned this issue Jul 5, 2024
Merged
21 tasks
elBoberido added a commit that referenced this issue Jul 5, 2024
@elBoberido
Merge pull request #2314 from elBoberido/iox-1295-make-iceoryx-versio…
2e38d15 
…n-available-for-in-tree-builds

iox-#1295 Make iceoryx version available for in-tree builds
elBoberido added a commit to elBoberido/iceoryx that referenced this issue Aug 14, 2024
@elBoberido
iox-eclipse-iceoryx#1295 Bump version to 2.95.1
dfee990
@elBoberido elBoberido mentioned this issue Aug 14, 2024
Merged
21 tasks
elBoberido added a commit that referenced this issue Aug 14, 2024
@elBoberido
Merge pull request #2322 from elBoberido/iox-1295-bump-version-to-2.95.1
d00f905 
iox-#1295 Bump version to 2.95.1
elBoberido added a commit to elBoberido/iceoryx that referenced this issue Aug 15, 2024
@elBoberido
iox-eclipse-iceoryx#1295 Bump version to 2.95.2
4979abb
@elBoberido elBoberido mentioned this issue Aug 15, 2024
Merged
21 tasks
elBoberido added a commit that referenced this issue Aug 15, 2024
@elBoberido
Merge pull request #2324 from elBoberido/iox-1295-bump-version-to-2.95.2
912931a 
iox-#1295 Bump version to 2.95.2
elBoberido added a commit to elBoberido/iceoryx that referenced this issue Oct 15, 2024
@elBoberido
iox-eclipse-iceoryx#1295 Update release script to check the version i…
a25fd10 
…n MODULES.bazel
elBoberido added a commit to elBoberido/iceoryx that referenced this issue Oct 15, 2024
@elBoberido
iox-eclipse-iceoryx#1295 Bump version to 2.95.3
763ca5d
elBoberido added a commit that referenced this issue Oct 15, 2024
@elBoberido
Merge pull request #2360 from elBoberido/iox-1295-bump-version-to-2.95.3
5fd7661 
iox-#1295 Bump version to v2.95.3
@elBoberido elBoberido mentioned this issue Oct 15, 2024
Merged
21 tasks
@mossmaurice mossmaurice added this to v3.0 Oct 31, 2024
@github-project-automation github-project-automation bot moved this to To do in v3.0 Oct 31, 2024
@mossmaurice mossmaurice mentioned this issue Oct 31, 2024
Closed
@mossmaurice mossmaurice moved this from To do to In progress in v3.0 Dec 23, 2024
@mossmaurice mossmaurice mentioned this issue Dec 23, 2024
Closed
27 tasks
mossmaurice added a commit to ApexAI/iceoryx that referenced this issue Dec 23, 2024
@mossmaurice
iox-eclipse-iceoryx#1295 Update version number to v3.0
b7b49c4
@mossmaurice mossmaurice mentioned this issue Dec 23, 2024
Closed
20 tasks
mossmaurice added a commit to ApexAI/iceoryx that referenced this issue Dec 23, 2024
@mossmaurice
iox-eclipse-iceoryx#1295 Update versions and MkDocs material related …
e7fe008 
…settings like CSS
This was referenced Dec 27, 2024
Draft
Draft
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@mossmaurice mossmaurice

Labels
documentation Improvements or additions to documentation
Projects
v3.0
Status: In progress
Milestone
No milestone
2 participants
@mossmaurice @elBoberido