Create "Getting Started with ODIS" guide

iodepo / odis-arch

Development of the Ocean Data and Information System (ODIS) architecture

https://book.odis.org/

29 stars 17 forks source link

Create "Getting Started with ODIS" guide #379

Closed pbuttigieg closed 3 months ago

pbuttigieg commented 8 months ago

A new page in the ODIS Book where partners can get a general overview of how to link their system to ODIS.

This should cover:

Creating and managing organisational identity in OceanExpert (including cleaning up legacy content)
Creating and managing data nodes in ODISCat
Developing ODIS Arch content using the Book
Creating and registering their sitemap.xml (with update frequency for config)
Triggering indexing and verifying content in OIH.

pbuttigieg commented 8 months ago

@fils @jmckenna

I'll lay out the skeleton and some text for this. Please add links to the appropriate documentation and resource pages (e.g. our OGTA content) where needed.

You can also add that in a list so I can work them in to the text as it develops

pbuttigieg commented 7 months ago

Ensure this guide is circulated to all IODE projects, sub-components, NODCs, ADUs, etc

jmckenna commented 6 months ago

Possibly include link to Google's Structured Data docs, where it has examples for several types including Dataset

jmckenna commented 5 months ago

useful SPARQL queries to add to the guide: https://api.triplydb.com/s/XMKVjO9-l

Lucy-Scott commented 5 months ago

The guide should be as simple as possible - where longer descriptions or side stories are needed, it should link to text / definitions in the Book

Lucy-Scott commented 5 months ago

For example, the starting outline can be exactly what Jeff sends to partners:

GETTING STARTED

create an entry in the ODIS Catalogue https://catalogue.odis.org/
- login with your OceanExpert ID
- important fields are
  - Startpoint URL for ODIS-Arch (this is the url to your sitemap.xml file)
  - Type of the ODIS-Arch URL (select "Sitemap")

embed JSON-LD on each record page in the catalogue → Modify ViewMetadata page to generate and include JSON-LD for each metadata entry create a sitemap.xml pointing to each record, and place the sitemap on the web → Create sitemap.xml including links to all metadata entries → Modify AddMetadata, UpdateMetadata, DeleteMetadata pages to update the sitemap.xml on changes

Lucy-Scott commented 5 months ago

Links to point to eg.

Example of Projects in JSON-LD: https://github.com/iodepo/odis-in/blob/master/dataGraphs/thematics/projects/graphs/proj.json

ODIS profiles/patterns: https://book.oceaninfohub.org/thematics/index.html#core-profiles

Lucy-Scott commented 5 months ago

So this is getting started for joining the ODIS network - next question:

Do we have a summary description somewhere of how other systems / portals can access records in the ODIS KG? Or whatever we want to point them to? @jmckenna

jmckenna commented 4 months ago

update:

there was already a nice template for the gettingStarted.md in the root of the book directory (here), I will combine the other getting-started.Md (from here), into this gettingStarted.md in the root of the book directory. Sorry for this confusion!