WorkPackage2 (Philip) - Githubissues

asam-ev / asam-project-guide

(WIP!) Project Guide for ASAM OpenX standards

Mozilla Public License 2.0

2 stars 0 forks source link

WorkPackage2 (Philip) #136

Closed florianwallerer closed 2 years ago

florianwallerer commented 2 years ago

[x] OpenSCENARIO 2 UML2adoc scripting adjustments as defined in #638 – This is limited to T0-T2 and is subject to a further evaluation by Avenyr. Additional tasks will be detailed together with the ASAM office and the responsible in the OSC 2 project.
[x] OSI – #73 Points 1 & 2 - Conceptual analysis of a Doxygen to AsciiDoc conversion for integration into the antora platform concept prepared by the team
[ ] Additional topics as listed in #73 will be addressed on a priority basis (this will be reevaluated by the office and adjusted in the issue by the office by 04.05.22)

Important: Further Project Guide specific topics will be clearly outlined by the ASAM office following an internal review of the working mode. These will be appended to the targets pending the meeting on 16.05.2022.

philipwindecker commented 2 years ago

First topic resolved today. MR assigned to @engelben. Will stay open until other reviews have concluded.

Changes have been discussed and reviewed together with Nicolas from osc2 team

philipwindecker commented 2 years ago

Second topic: First examples have been added and linked. Examples are being developed in the Antora MVP repository.

philipwindecker commented 2 years ago

Third topic: For transparency:

Developing a solution for displaying non-normative sections in a standard already happened in April and needs to be reviewed at some point.
For the bibtex solution, it should be better to wait since there seems to be someone working on a similar problem already (converting the ruby solution to a javascript solution, which should be compatible with or, at least, easier to adapt for Antora)

philipwindecker commented 2 years ago

Upon request, I co-developed a script for osc2 cleaning up the multitude of partials as much as possible. https://code.asam.net/simulation/standard/openscenario-2.0/-/tree/partials_cleanup_branch

philipwindecker commented 2 years ago

Second topic: First draft of PoC has been developed and discussed with Stefan. Now, last steps for a project presentation have to be taken as described in https://github.com/asam-ev/asam-project-guide/issues/133#issuecomment-1123703564

philipwindecker commented 2 years ago

Side note: Unexpected delays due to incorrect and conflicting doxygen configuration in provided example repo regarding docker image encountered. The pipeline configuration in GitHub uses a different and older setup (Ubuntu 18.04 + c compiler GNU 7.5.0 + doxygen 1.8.13) compared to the demo repo (Debian with python + c compiler GNU 10.2.1 + doxygen 1.9.1) which produces different results, possibly because doxygen has experienced breaking changes that were hidden both in a minor and in a bugfix update (going by some forum posts). However, this also brought to light that even the given setup in the current pipeline does not produce all the specified content as there is some information that is only rendered in the new setup. However, the new setup has more problems than additional content (e.g. the navigation is broken), so a lot of time was spent to identify the problem and create new images with the old setup for both the demo repo and the project guide image used in the PoC.

EDIT: Just downgrading doxygen does not solve the problem! It seems to be induced by cmake or the combination of both!

philipwindecker commented 2 years ago

OSI topic has been presented to team. Now waiting for feedback for further steps and improvements.

philipwindecker commented 2 years ago

Currently working on adding extensive documentation to created extensions.

florianwallerer commented 2 years ago

As "Additional topics as listed in https://github.com/asam-ev/asam-project-guide/issues/73 will be addressed on a priority basis" this was optional, this issue will be closed.