InformationModel icon indicating copy to clipboard operation
InformationModel copied to clipboard

Get documentation ready for IDS RAM 4.0

Open clange opened this issue 4 years ago • 3 comments

Current ideas:

  1. RAM should be a high-level "digest", e.g., mention the C-hexagon but not the concrete W3C standards such as DCAT
  2. detailed documentation would be best to maintain in the static texts within the Widoco-generated documentation at https://w3id.org/idsa/core (as this will be updated in accordance with the infomodel release cycle)
  3. IDS-G (via pull requests on IDS-G-pre) should be made sure to be up to date w.r.t. what's in (2.)

Task:

  1. Analyze and document how the text content of the sections of https://w3id.org/idsa/core is generated
  2. Update this content as much as possible. At least update to RAM 3.0 (e.g., by storing text and images from the RAM 3.0 PDF in this repository and use it for generation)

clange avatar Nov 25 '21 14:11 clange

FYI most (if not all) information is created by a python script: https://github.com/International-Data-Spaces-Association/InformationModel/blob/gh-pages/docs/config/widoco.py

JohannesLipp avatar Jun 23 '22 13:06 JohannesLipp

Blocked by #571

JohannesLipp avatar Jun 23 '22 13:06 JohannesLipp

@PHochmann Please note that the blocker #571 is solved now.

JohannesLipp avatar Aug 01 '22 09:08 JohannesLipp