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

Improve documentation and website for v2.0 #743

Closed
53 tasks done
mossmaurice opened this issue Apr 15, 2021 · 3 comments · Fixed by #746, #716, #849, #1015 or #1123
Closed
53 tasks done

Improve documentation and website for v2.0 #743

mossmaurice opened this issue Apr 15, 2021 · 3 comments · Fixed by #746, #716, #849, #1015 or #1123
Assignees
@mossmaurice
Labels
documentation Improvements or additions to documentation

Comments

@mossmaurice
Copy link
Contributor

mossmaurice commented Apr 15, 2021 •
edited
Loading

Brief feature description

2.0 Release

Website/Markdown settings

  • Open Bugzilla issue to "enforce https"
  • Create favicon for website
  • Switch to mike v1.0 to avoid duplication for aliases
  • Add .markdownlint.yaml file Moved to Release validation for v3.0 #1295

Common

New articles/examples

  • Add chunk header example
  • Add example sending complex data types
  • Add section on CI setup (e.g. Axivion)
  • Add pub/sub matching criteria table
  • Add architecture article under concepts
  • Replace all GitHub link with fixed version https://github.com/eclipse-iceoryx/iceoryx/tree/v2.0.0/
  • How to write integration tests Moved to Release validation for v3.0 #1295
  • Record asciicast for
    • icecrystal (outdated)
    • icedelivery
    • icediscovery
    • icediscovery_in_c
    • icedocker
    • iceensemble (outdated)
    • iceperf
    • maybe: request_response - the waitset/listener example is described, recorded the basic example
    • request_response_in_c

Obligatory fixes

Review design docs (@elfenpiff )

  • top level readme
  • chunk header
  • error handling
  • listener
  • doc/design/lockfree_queue.md (@MatthiasKillat )
  • relocatable pointer (@MatthiasKillat )
  • request response communication
  • service discovery
  • template

Ideas

  • Blog post section? Not relevant
  • Performance results section? Moved to Release validation for v3.0 #1295
  • Add conference / community section with chat, dev meetup, mailing list (or help and ressources?) Not relevant
  • Add Cyclone DDS link Not relevant
  • Mention Eclipse Foundation and OpenADx on start page, also Default middleware together with Cyclone DDS Not relevant

Strech goals
@mossmaurice mossmaurice added the documentation Improvements or additions to documentation label Apr 15, 2021
@mossmaurice mossmaurice mentioned this issue Apr 15, 2021
Closed
24 tasks
@mossmaurice mossmaurice changed the title Improve documentation for v2.0 Improve documentation and website for v2.0 Apr 15, 2021
@mossmaurice mossmaurice mentioned this issue Apr 15, 2021
Closed
18 tasks
mossmaurice pushed a commit to ApexAI/iceoryx that referenced this issue Apr 15, 2021
@mossmaurice-apexai
iox-eclipse-iceoryx#743 Ignore unfound files when generating website
2c95bf9 
Signed-off-by: Simon Hoinkis <simon.hoinkis@apex.ai>
mossmaurice pushed a commit to ApexAI/iceoryx that referenced this issue Apr 16, 2021
@mossmaurice-apexai
iox-eclipse-iceoryx#743 Fix include issue
f03a33d 
Signed-off-by: Simon Hoinkis <simon.hoinkis@apex.ai>
mossmaurice pushed a commit to ApexAI/iceoryx that referenced this issue Apr 19, 2021
@mossmaurice-apexai
iox-eclipse-iceoryx#743 Fix include issue
468e214 
Signed-off-by: Simon Hoinkis <simon.hoinkis@apex.ai>
mossmaurice pushed a commit to ApexAI/iceoryx that referenced this issue Apr 19, 2021
@mossmaurice-apexai
Merge remote-tracking branch 'origin/master' into iox-eclipse-iceoryx…
39aa33e 
…#743-fix-docu-generation
mossmaurice pushed a commit to ApexAI/iceoryx that referenced this issue Apr 19, 2021
@mossmaurice-apexai
iox-eclipse-iceoryx#743 Fix typo on start page
30e516d 
Signed-off-by: Simon Hoinkis <simon.hoinkis@apex.ai>
mossmaurice pushed a commit to ApexAI/iceoryx that referenced this issue Apr 19, 2021
@mossmaurice-apexai
iox-eclipse-iceoryx#743 Make link absolute to work for website and gi…
1e2e91a 
…thub

Signed-off-by: Simon Hoinkis <simon.hoinkis@apex.ai>
mossmaurice pushed a commit to ApexAI/iceoryx that referenced this issue Apr 19, 2021
@mossmaurice-apexai
iox-eclipse-iceoryx#743 Ignore unfound files when generating website
fc07f12 
Signed-off-by: Simon Hoinkis <simon.hoinkis@apex.ai>
mossmaurice pushed a commit to ApexAI/iceoryx that referenced this issue Apr 19, 2021
@mossmaurice-apexai
iox-eclipse-iceoryx#743 Fix include issue
4e7e947 
Signed-off-by: Simon Hoinkis <simon.hoinkis@apex.ai>
mossmaurice pushed a commit to ApexAI/iceoryx that referenced this issue Apr 19, 2021
@mossmaurice-apexai
iox-eclipse-iceoryx#743 Fix typo on start page
457a578 
Signed-off-by: Simon Hoinkis <simon.hoinkis@apex.ai>
@mossmaurice mossmaurice mentioned this issue Apr 19, 2021
Merged
19 tasks
@mossmaurice mossmaurice linked a pull request Apr 19, 2021 that will close this issue
Iox #743 Fix website generation and typos #746
Merged
19 tasks
elfenpiff added a commit to ApexAI/iceoryx that referenced this issue Apr 20, 2021
@elfenpiff
iox-eclipse-iceoryx#743 added attributes.hpp documentation in utils o…
30379b4 
…verview

Signed-off-by: Christian Eltzschig <me@elchris.org>
Merged
19 tasks
elfenpiff added a commit to ApexAI/iceoryx that referenced this issue Apr 20, 2021
@elfenpiff
iox-eclipse-iceoryx#743 added missing underscores in macro __clang_ma…
79378cd 
…jor(__)

Signed-off-by: Christian Eltzschig <me@elchris.org>
elfenpiff added a commit to ApexAI/iceoryx that referenced this issue Apr 20, 2021
@elfenpiff
iox-eclipse-iceoryx#743 more fine grained IOX_NO_DISCARD feature sele…
612d5de 
…ction

Signed-off-by: Christian Eltzschig <me@elchris.org>
elfenpiff added a commit to ApexAI/iceoryx that referenced this issue Apr 20, 2021
@elfenpiff
iox-eclipse-iceoryx#743 adjusted endif and using elif instead of else…
ff8edb8 
… and another if in attribute macros

Signed-off-by: Christian Eltzschig <me@elchris.org>
elfenpiff added a commit to ApexAI/iceoryx that referenced this issue Apr 20, 2021
@elfenpiff
iox-eclipse-iceoryx#743 IOX_FALLTHROUGH is noop for clang on linux
09de1c3 
Signed-off-by: Christian Eltzschig <me@elchris.org>
elfenpiff added a commit that referenced this issue Apr 21, 2021
@elfenpiff
Merge pull request #747 from ApexAI/iox-#743-add-attribute-docu-in-ut…
73a07a4 
…ils-overview

iox-#743 added attributes.hpp documentation in utils overview
mossmaurice pushed a commit to ApexAI/iceoryx that referenced this issue Apr 22, 2021
@mossmaurice-apexai
iox-eclipse-iceoryx#743 Generate doxybook2 config files to fix doxyge…
85c495f 
…n links, update mike, add sanity check for path and fix broken link in utils readme

Signed-off-by: Simon Hoinkis <simon.hoinkis@apex.ai>
mossmaurice pushed a commit that referenced this issue Apr 26, 2021
@mossmaurice-apexai
Merge pull request #746 from ApexAI/iox-#743-fix-website-generation
5239738 
Iox #743 Fix website generation and typos
@mossmaurice mossmaurice reopened this Apr 27, 2021
@mossmaurice mossmaurice self-assigned this Apr 27, 2021
mossmaurice pushed a commit to ApexAI/iceoryx that referenced this issue Apr 28, 2021
@mossmaurice-apexai
iox-eclipse-iceoryx#743 Ignore unfound files when generating website
a8e28b9 
Signed-off-by: Simon Hoinkis <simon.hoinkis@apex.ai>
mossmaurice pushed a commit to ApexAI/iceoryx that referenced this issue Apr 28, 2021
@mossmaurice-apexai
iox-eclipse-iceoryx#743 Fix include issue
7de127f 
Signed-off-by: Simon Hoinkis <simon.hoinkis@apex.ai>
mossmaurice pushed a commit to ApexAI/iceoryx that referenced this issue Apr 28, 2021
@mossmaurice-apexai
iox-eclipse-iceoryx#743 Fix typo on start page
9af13fa 
Signed-off-by: Simon Hoinkis <simon.hoinkis@apex.ai>
elfenpiff added a commit to ApexAI/iceoryx that referenced this issue Mar 14, 2022
@elfenpiff
iox-eclipse-iceoryx#743 Increase readability, consistency, update cop…
f98f7ad 
…yright year and readme

Signed-off-by: Christian Eltzschig <me@elchris.org>
mossmaurice pushed a commit to ApexAI/iceoryx that referenced this issue Mar 14, 2022
@mossmaurice-apexai
iox-eclipse-iceoryx#743 Re-add doxygen to docs and remove unrelease r…
b8bdd1c 
…elease notes

Signed-off-by: Simon Hoinkis <simon.hoinkis@apex.ai>
mossmaurice pushed a commit to ApexAI/iceoryx that referenced this issue Mar 14, 2022
@mossmaurice-apexai
iox-eclipse-iceoryx#743 Remove design navigation entry
7763b74 
Signed-off-by: Simon Hoinkis <simon.hoinkis@apex.ai>
mossmaurice pushed a commit to ApexAI/iceoryx that referenced this issue Mar 14, 2022
@mossmaurice-apexai
iox-eclipse-iceoryx#743 Add links to new asciinema recordings
653b785 
Signed-off-by: Simon Hoinkis <simon.hoinkis@apex.ai>
mossmaurice pushed a commit to ApexAI/iceoryx that referenced this issue Mar 15, 2022
@mossmaurice-apexai
iox-eclipse-iceoryx#743 Add links to new asciinema recordings
58719d8 
Signed-off-by: Simon Hoinkis <simon.hoinkis@apex.ai>
This was referenced Mar 15, 2022
Merged
Merged
mossmaurice pushed a commit to ApexAI/iceoryx that referenced this issue Mar 15, 2022
@mossmaurice-apexai
iox-eclipse-iceoryx#743 Re-add doxygen to docs and remove unrelease r…
b9eab51 
…elease notes

Signed-off-by: Simon Hoinkis <simon.hoinkis@apex.ai>
mossmaurice pushed a commit to ApexAI/iceoryx that referenced this issue Mar 15, 2022
@mossmaurice-apexai
iox-eclipse-iceoryx#743 Remove design navigation entry
b34f308 
Signed-off-by: Simon Hoinkis <simon.hoinkis@apex.ai>
@mossmaurice mossmaurice mentioned this issue Mar 15, 2022
Merged
21 tasks
mossmaurice pushed a commit to ApexAI/iceoryx that referenced this issue Mar 15, 2022
@mossmaurice-apexai
iox-eclipse-iceoryx#743 Add links to new asciinema recordings
daa2306 
Signed-off-by: Simon Hoinkis <simon.hoinkis@apex.ai>
@mossmaurice mossmaurice mentioned this issue Mar 15, 2022
Merged
21 tasks
elfenpiff added a commit that referenced this issue Mar 15, 2022
@elfenpiff
Merge pull request #1284 from ApexAI/iox-#743-fix-windows-c-waitset-e…
608dda8 
…xample

Iox #743 fix windows c waitset example
elfenpiff added a commit that referenced this issue Mar 15, 2022
@elfenpiff
Merge pull request #1282 from ApexAI/iox-#743-review-configuration-guide
e88216b 
iox-#743 Review configuration guide
mossmaurice pushed a commit to ApexAI/iceoryx that referenced this issue Mar 16, 2022
@mossmaurice-apexai
iox-eclipse-iceoryx#743 Add links to new asciinema recordings
87440cd 
Signed-off-by: Simon Hoinkis <simon.hoinkis@apex.ai>
mossmaurice pushed a commit to ApexAI/iceoryx that referenced this issue Mar 16, 2022
@mossmaurice-apexai
iox-eclipse-iceoryx#743 Add links to new asciinema recordings
2c9a3df 
Signed-off-by: Simon Hoinkis <simon.hoinkis@apex.ai>
mossmaurice pushed a commit that referenced this issue Mar 16, 2022
@mossmaurice-apexai
Merge pull request #1289 from ApexAI/iox-#743-export-docs-to-iceoryx-io
73d6d59 
iox-#743 Fixes to make docs exportable (`v2.x`)
mossmaurice pushed a commit that referenced this issue Mar 16, 2022
@mossmaurice-apexai
Merge pull request #1290 from ApexAI/iox-#743-export-docs-to-iceoryx-…
da6419a 
…io-master

iox-#743 Fixes to make docs exportable (`master`)
@mossmaurice mossmaurice reopened this Mar 16, 2022
mossmaurice pushed a commit that referenced this issue Mar 16, 2022
@mossmaurice-apexai
Merge pull request #1291 from ApexAI/iox-#743-update-asciinema-record…
be4e079 
…ings-master

iox-#743 Add links to new asciinema recordings (`master`)
mossmaurice pushed a commit that referenced this issue Mar 16, 2022
@mossmaurice-apexai
Merge pull request #1288 from ApexAI/iox-#743-update-asciinema-record…
3f5cf85 
…ings

iox-#743 Add links to new asciinema recordings (`v2.x`)
@mossmaurice mossmaurice reopened this Mar 16, 2022
mossmaurice pushed a commit to ApexAI/iceoryx that referenced this issue Mar 17, 2022
@mossmaurice-apexai
iox-eclipse-iceoryx#743 Rename executables of icediscovery
355e746 
Signed-off-by: Simon Hoinkis <simon.hoinkis@apex.ai>
mossmaurice pushed a commit to ApexAI/iceoryx that referenced this issue Mar 17, 2022
@mossmaurice-apexai
iox-eclipse-iceoryx#743 Fix typos, line length and rename 'Image' Eve…
4844e20 
…ntId to 'Objects' for Radar service

Signed-off-by: Simon Hoinkis <simon.hoinkis@apex.ai>
mossmaurice pushed a commit to ApexAI/iceoryx that referenced this issue Mar 17, 2022
@mossmaurice-apexai
iox-eclipse-iceoryx#743 Adapt icediscovery integration test to renami…
6fca160 
…ng of topic

Signed-off-by: Simon Hoinkis <simon.hoinkis@apex.ai>
mossmaurice pushed a commit to ApexAI/iceoryx that referenced this issue Mar 17, 2022
@mossmaurice-apexai
iox-eclipse-iceoryx#743 Rename executables of icediscovery
2a87e5b 
Signed-off-by: Simon Hoinkis <simon.hoinkis@apex.ai>
elfenpiff added a commit that referenced this issue May 17, 2022
@elfenpiff
Merge pull request #1248 from ApexAI/iox-#743-remove-helix-qac-readme
c534165 
iox-#743 Remove HelixQAC tool documentation
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
None yet
Milestone
No milestone
5 participants
@mossmaurice @budrus @elBoberido @FerdinandSpitzschnueffler @fred-apex-ai