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.

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

Update documentation once breaking changes are approved #607

Open
lcomet opened this issue Nov 30, 2023 · 2 comments
Open

Update documentation once breaking changes are approved #607

lcomet opened this issue Nov 30, 2023 · 2 comments
Assignees

Comments

@lcomet
Copy link
Member

lcomet commented Nov 30, 2023

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
Copy link
Member Author

lcomet commented Dec 18, 2023

@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
Copy link
Member

@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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants