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

Get documentation ready for IDS RAM 4.0 #526

Open
clange opened this issue Nov 25, 2021 · 3 comments
Open

Get documentation ready for IDS RAM 4.0 #526

clange opened this issue Nov 25, 2021 · 3 comments
Assignees
Labels
enhancement ticket proposing an improvement, extension of exisitng or new features w3id
Milestone

Comments

@clange
Copy link
Member

clange commented Nov 25, 2021

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 clange added this to the RAM4.0 milestone Nov 25, 2021
@JohannesLipp JohannesLipp added enhancement ticket proposing an improvement, extension of exisitng or new features w3id labels May 12, 2022
@JohannesLipp
Copy link
Member

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

Blocked by #571

@JohannesLipp
Copy link
Member

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement ticket proposing an improvement, extension of exisitng or new features w3id
Projects
None yet
Development

No branches or pull requests

4 participants