iox-#743 Set documentation links to latest/master

[mossmaurice]

Signed-off-by: Simon Hoinkis [email protected]

Pre-Review Checklist for the PR Author

1. Code follows the coding style of CONTRIBUTING.md
2. Tests follow the best practice for testing
3. Changelog updated in the unreleased section including API breaking changes
4. Branch follows the naming format (iox-#123-this-is-a-branch)
5. Commits messages are according to this guideline
   • Commit messages have the issue ID (iox-#123 commit text)
   • Commit messages are signed (git commit -s)
   • Commit author matches Eclipse Contributor Agreement (and ECA is signed)
6. Update the PR title
   • Follow the same conventions as for commit messages
   • Link to the relevant issue
7. Relevant issues are linked
8. Add sensible notes for the reviewer
9. All checks have passed (except task-list-completed)
10. Assign PR to reviewer

Notes for Reviewer

• Set documentation links to latest/master

Checklist for the PR Reviewer

• Commits are properly organized and messages are according to the guideline
• Code according to our coding style and naming conventions
• Unit tests have been written for new behavior
  • Each unit test case has a unique UUID
• Public API changes are documented via doxygen
• Copyright owner are updated in the changed files
• PR title describes the changes

Post-review Checklist for the PR Author

1. All open points are addressed and tracked via issues

References

• Closes Improve documentation and website for v2.0 #743 (partly)

[codecov]

Codecov Report

Merging #1255 (79c5fd2) into master (0696c01) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master    #1255   +/-   ##
=======================================
  Coverage   78.93%   78.93%           
=======================================
  Files         370      370           
  Lines       14705    14705           
  Branches     2059     2059           
=======================================
  Hits        11608    11608           
- Misses       2416     2417    +1     
+ Partials      681      680    -1     

Flag	Coverage Δ
unittests	78.17% <ø> (+0.01%)	⬆️
unittests_timing	15.48% <ø> (-0.02%)	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files	Coverage Δ
iceoryx_hoofs/source/posix_wrapper/timer.cpp	63.07% <0.00%> (-0.83%)	⬇️
...nternal/relocatable_pointer/pointer_repository.inl	88.63% <0.00%> (+2.27%)	⬆️
iceoryx_hoofs/source/concurrent/loffli.cpp	91.42% <0.00%> (+2.85%)	⬆️

[elBoberido]

With the backport of release_2.0 to master this PR should be obsolete

[mossmaurice]

With the backport of release_2.0 to master this PR should be obsolete

I fear that's not the case, some links are still pointing to v2.0.0 on master and not to master / latetest e.g.

iceoryx_examples/iceoptions/README.md:100
[here](https://iceoryx.io/v2.0.0/getting-started/overview/#restrictions)

iceoryx_examples/complexdata/README.md:7
For more information about this limitation see the [QoS article](https://iceoryx.io/v2.0.0/concepts/qos-policies/).

[elBoberido]

@mossmaurice since the homepage doesn't have a master version, it is not possible use master is such cases yet

[mossmaurice]

@mossmaurice since the homepage doesn't have a master version, it is not possible use master is such cases yet

That's true, there is CI set up for that yet. However, MkDocs a supports redirection feature already forwarding to latest version via iceoryx.io/latest. Once we have master on iceoryx.io the latest redirection should be removed. Till then it would make more sense to me to link to latest than a fixed version which will forward to master in future, e.g. imagine someone works on on old branch clicks on latest link and is then redirected to master because the CI builds it then.