832 consolidate hosted osi documentation sources

[philipwindecker]

Reference to a related issue in the repository

#832

Add a description

Remove legacy links.

Take this checklist as orientation for yourself, if this PR is ready for the Change Control Board:

• My suggestion follows the style and contributors guidelines.
  • Irrelevant - changes made to pipeline, not content
• I have taken care about the message documentation and the fields and enums documentation.
  • Irrelevant - changes made to pipeline, not content
• I have done the DCO signoff.
• My changes generate no errors when passing CI tests.
• I have successfully implemented and tested my fix/feature locally.
  • Irrelevant - changes made to pipeline, not content
• Appropriate reviewer(s) are assigned.

If you can’t check all of them, please explain why.
If all boxes are checked or commented and you have achieved at least one positive review, you can assign the label ReadyForCCBReview!

[TimmRuppert]

Looks good to me! Thanks!

Just a reminder for later-me/others: To close #832 we also need a PR in this repo to cleanup the gh-pages branch (as discussed in the issue)

[TimmRuppert]

I just had a second look, I think we also should change the proto file:

open-simulation-interface/osi_version.proto.in

Line 31 in b00ad2b

// [1] Open Simulation Interface. (2020, January 25). <em>README</em>. Retrieved January 25, 2020, from https://opensimulationinterface.github.io/osi-documentation/open-simulation-interface/README.html

As expected, this shows also up in the documentation.

I would simply write something like:

The meaning of different InterfaceVersions is defined in the versioning chapter of the official OSI documentation.

Or if somebody really wants a reference, than point to a page that actually explains this like https://opensimulationinterface.github.io/osi-antora-generator/asamosi/V3.7.0/specification/general_docs/versioning.html (this is a fixed 3.7. link..)

[philipwindecker]

I just had a second look, I think we also should change the proto file:

open-simulation-interface/osi_version.proto.in

Line 31 in b00ad2b

// [1] Open Simulation Interface. (2020, January 25). <em>README</em>. Retrieved January 25, 2020, from https://opensimulationinterface.github.io/osi-documentation/open-simulation-interface/README.html

As expected, this shows also up in the documentation.

I would simply write something like:

The meaning of different InterfaceVersions is defined in the versioning chapter of the official OSI documentation.

Or if somebody really wants a reference, than point to a page that actually explains this like https://opensimulationinterface.github.io/osi-antora-generator/asamosi/V3.7.0/specification/general_docs/versioning.html (this is a fixed 3.7. link..)

This is true and I noticed it as well.
However, it technically would still be correct, since the retrieval date is given (meaning it does not need to stay available).

But I agree that it would be better to point to the documentation (with an updated date) and not the README (whose link is not working any longer). A fixed version, however, will only work if the version is not latest (in the current setup, at least).

For now, I will go without the link.

[jdsika]

@pmai and @engelben how would we proceed without a CCB in place? Shall I merge through the power of Grayskull

[engelben]

As these changes are editorial I am ok with merging this to main without a CCB. Especially as a merge to main is not equivalent to a release.

[engelben]

Let’s keep the spirit of Eternia alive! 🚀

@jdsika I am fine if you go ahead with the merge, we have enough members of the prior CCB that have approved this topic and the changes are editorial.