Create SO:Dataset to DataONE solr crosswalk about d1_cn_index_processor HOT 4 CLOSED

@mbjones regarding the DataONE API documentation detailing the SO:Dataset indexing, I followed the example of current documentation such as https://releases.dataone.org/online/api-documentation-v2.0/design/SearchMetadata_eml.html, which shows XPaths and references to the KNB EML documentation.

• For the 'Path' column, for SO:Dataset, instead of XPaths I put SPARQL queries that were used to extract properties from the JSON-LD documents. While most readers won't require this level of technical detail, it does accurately show how the info is extracted.
• also for the 'Reference' column I referred to the appropriate section in the ESIP SOSO guide, instead of referring to https://schema.org, which doesn't provide context for the fields used, i.e. for Solr author, the property extracted is https://schema.org/name, but in the context of SO:Dataset > SO:creator

Is this approach to documenting the SO:Dataset indexing valid, or should a different one be used?

from d1_cn_index_processor.

Sounds like a good approach to me @gothub . Several groups have asked for our crosswalks recently, so that is good to keep documented. I have also pointed them at the config files for the indexer which actually has all of the crosswalks, whereas in sphinx I think we are missing some. But this sounds good.

Where can I see this document? Did you add it to https://github.com/DataONEorg/api-documentation?

from d1_cn_index_processor.

The document will be added to that repo this morning, when I've successfully built the documentation locally. It's almost ready, I just have to finish configuring the python tools required for the doc build.

from d1_cn_index_processor.

This issue has been superseded by DataONEorg/api-documentation#14

from d1_cn_index_processor.