Download as PDF, PPTX
Uploaded byEUDAT
Ariyo - EUDAT CDI B2 services documentation
This document discusses writing effective service documentation for the EUDAT B2 suite of services. It provides an overview of the EUDAT B2 services and research data lifecycle context. It describes the approach to documentation writing, including identifying the end users and leveraging documentation from core technologies. The format and locations of documentation for services like B2ACCESS, B2DROP, B2FIND, B2HANDLE, B2SAFE, and B2SHARE are outlined, including code repositories, descriptions, usage guides, and training materials.
Ariyo - EUDAT CDI B2 services documentation
- 1. eudat.eu @eudat_eu Chris Ariyo| EUDAT CDI B2SHARE Service Owner WRITING EFFECTIVE SERVICE DOCUMENTATION FOR THE EUDAT B2 SUITE June 23rd , 2022 @ EOSC Future – ENVRI: Training on service documentation & tutorial writing
- 2. 2 Outline EUDAT CDI ServicesOverview EUDAT CDI B2 Services Documentation • Approach to Documentation writing • Format & Location of Documentation • B2ACCESS, B2DROP, B2FIND, B2HANDLE, B2SAFE, B2SHARE
- 3. eudat.eu @eudat_eu EUDAT CDIB2 SERVICES OVERVIEW
- 4. EUDAT B2 ServicesSuite
- 5. Research Data LifeCycle in context of EUDAT building blocks
- 6.
- 7. 7 Approach to WritingUser Documentation Who is the End User for the documentation? Documentation Sources & Team(s) • Core Technology Developers & Documentation • B2ACCESS – Unity IDM (https://www.unity-idm.eu/) • B2DROP – NextCloud https://nextcloud.com/ • B2FIND – CKAN https://ckan.org/ • B2HANDLE - Handle system server/client toolkit https://www.handle.net/ • B2SAFE – iRODS https://www.irods.org/ • B2SHARE – Invenio https://invenio-software.org/ • B2 Services Developers • Non B2 Services Developers • Web Developers • Users
- 8. 8 Codes • https://github.com/EUDAT-B2ACCESS • https://github.com/EUDAT-B2DROP •https://github.com/EUDAT-B2FIND • https://gitlab.eudat.eu/b2safe/B2HANDLE • https://gitlab.eudat.eu/b2safe Description/Catalog • https://sp.eudat.eu/catalog Usage/Deployment • https://eudat.eu/services/userdoc/b2access-usage • https://eudat.eu/services/userdoc/b2drop • https://eudat.eu/services/userdoc/b2find-usage • https://eudat.eu/services/userdoc/b2handle-for-end-users • https://eudat.eu/services/userdoc/irods-deployment Training • https://b2drop.eudat.eu/s/Z8Oej8sthZiqYdp • https://b2drop.eudat.eu/s/2GpFzSjMvW1IwIs • https://github.com/EUDAT-Training/B2FIND-Training • https://b2drop.eudat.eu/s/nHc0T3TIWoEGcVP • https://eudat.eu/b2safe-training-suite Location & Format of Service Documentation
- 9. 9 Codes – https://github.com/EUDAT-B2SHARE| https://gitlab.eudat.eu/eudat-metadata/eudat-core-schema Location & Format of Service Documentation
- 10. 10 • Description/Catalog –https://sp.eudat.eu/catalog Location & Format of Service Documentation
- 11. 11 Usage – https://eudat.eu/services/userdoc/b2share-usage Location& Format of Service Documentation
- 12. 12 Training - https://b2drop.eudat.eu/s/6l02aZtSCB8cuja Location& Format of Service Documentation
- 13. eudat.eu @eudat_eu COMMENTS ? QUESTIONS? Chris Ariyo Chris.Ariyo@csc.fi EUDAT CDI B2SHARE Service Owner