search

FAIR-DS4NFDI / wiki

Documentation of repositories and services used within the BMBF project FAIR-DS.
https://fair-ds4nfdi.github.io/wiki/
Other
0 stars 1 forks source link

Add documentation/wiki entry for technologies #2

Open St4NNi opened 1 month ago

St4NNi commented 1 month ago

This is an issue to collect ideas what could be documented in the "technologies" section:

  1. Expand and refine the information from here: https://github.com/FAIR-DS4NFDI/wiki/wiki/WP3-WP4-Technical-Foundations-and-Demonstrators

Especially focus on how they fit in a "FAIR-DS" architecture.

hk-accurids commented 1 month ago

It would be great to have a stepwise guideline of how to exchange data following the IDS protocol, including example JSON messages. E.g.

  1. Create asset Example POST Example RESPONSE
  2. Create policy etc
hk-accurids commented 1 month ago

What about a section about recommended documentation? Like a "read this first". It could help the next contributors to onboard more efficiently.

St4NNi commented 1 month ago

It would be great to have a stepwise guideline of how to exchange data following the IDS protocol, including example JSON messages. E.g.

1. Create asset
   Example POST
   Example RESPONSE

2. Create policy
   etc

Yes, but we should reference the official documentation for this, just to be sure that it is as up-to-date as possible.

hk-accurids commented 1 month ago

@St4NNi I have added a page about the EDC connector with example messages. The documentation renders well in Github but it does not yet work well with mbook. Could you please have a look?

St4NNi commented 1 month ago

@St4NNi I have added a page about the EDC connector with example messages. The documentation renders well in Github but it does not yet work well with mbook. Could you please have a look?

@hk-accurids The mdbook automatic translation to .html files will only work if the markdown file is part of the SUMMARY.md i shouldve fixed it with https://github.com/FAIR-DS4NFDI/wiki/commit/f5f36317efd2379ec45880c95304aee27301be8a

hk-accurids commented 1 month ago

Perfect! thank you @St4NNi