search

International-Data-Spaces-Association / InformationModel

The Information Model of the International Data Spaces implements the IDS reference architecture as an extensible, machine readable and technology independent data model.
Apache License 2.0
61 stars 35 forks source link

Update documentation once breaking changes are approved #607

Open lcomet opened 7 months ago

lcomet commented 7 months ago

Once the breaking changes in #601 are approved, regenerate the documentation, as several classes and properties were removed.

For generating new documentation, we need a new release 4.2.1 with the changes introduced in #601. Moreover, a refactoring of the code in the widoco.py script is necessary to detach all the Jive-related text. Instead of the current text (obtained by the function get_content_documentation_information), proceed as described in #526

lcomet commented 6 months ago

@JohannesLipp @clange what is the current status of the procedure to generate releases of the Infomodel? The last Infomodel Nightly is from September 2022. Currently, we use the releases to automatically generate the documentation of the model we show here

JohannesLipp commented 5 months ago

@pnlinden can you help with that? (and confirm my guess below?)

@lcomet An additional resource might be the "contribution guidelines", esp. its section on "release branches": https://github.com/International-Data-Spaces-Association/InformationModel/blob/a9b79eab4fe148dd6237fa456253070f0e6cb686/CONTRIBUTING.md#release-branches In short, one uses a Git tag and merges it to a certain branch to trigger automatic processing.