cessda / cessda.cdc.versions

Issue track and wiki for the CESSDA Data Catalogue
https://datacatalogue.cessda.eu/
Apache License 2.0
0 stars 0 forks source link

Add details of ingest to the documentation #401

Closed cessda-bitbucket-importer closed 2 years ago

cessda-bitbucket-importer commented 2 years ago

Original report on BitBucket by Carsten Thiel (GitHub: schildwaechter).


That should explain how an SP gets into CDC, i.e. OAI-PMH with DDI data and checked via validator.

That would be the page we give an SP who wants to connect.

cessda-bitbucket-importer commented 2 years ago

Original comment by John Shepherdson (GitHub: john-shepherdson).


Can use this as starting point (for collective editing): https://docs.google.com/document/d/1pC8O5VL2fDusfu6nFHRG1M6YfHqAiL_9GTYN7fuAYJE/edit?usp=sharing

cessda-bitbucket-importer commented 2 years ago

Original comment by John Shepherdson (GitHub: john-shepherdson).


Some text re CDC validation pipeline which we can reuse (copy/paste) here: https://docs.google.com/document/d/19ZDpaFMFq63J5_0UzcMzru0MhbvQKoF22SJJMOlcE5s/edit

cessda-bitbucket-importer commented 2 years ago

Original comment by John Shepherdson (GitHub: john-shepherdson).


See https://docs.tech.cessda.eu/cdc/new-endpoint.html

cessda-bitbucket-importer commented 2 years ago

Original comment by Carsten Thiel (GitHub: schildwaechter).


I’d still prefer to just remove the NESSTAR section.

Also, this need to be in the CDC doc, hence the ticket in this issue tracker.

cessda-bitbucket-importer commented 2 years ago

Original comment by John Shepherdson (GitHub: john-shepherdson).


My fault, wrong link. See attached

cessda-bitbucket-importer commented 2 years ago

Original comment by John Shepherdson (GitHub: john-shepherdson).


cessda-bitbucket-importer commented 2 years ago

Original comment by John Shepherdson (GitHub: john-shepherdson).


cessda-bitbucket-importer commented 2 years ago

Original comment by Carsten Thiel (GitHub: schildwaechter).


documentation needs to be in CDC documentation/user guide and verifyable with link to staging

cessda-bitbucket-importer commented 2 years ago

Original comment by Taina Jääskeläinen.


Can we say in the CDC documentation that any organisation that has SSH data endpoint and is willing to make it compatible with CESSDA’s technical and metadata requirements, is welcome to contact CESSDA?

cessda-bitbucket-importer commented 2 years ago

Original comment by Carsten Thiel (GitHub: schildwaechter).


not yet, part of the new strategy is to define whom we want

cessda-bitbucket-importer commented 2 years ago

Original comment by John Shepherdson (GitHub: john-shepherdson).


See https://datacatalogue-dev.cessda.eu/documentation/new-endpoint.html

cessda-bitbucket-importer commented 2 years ago

Original comment by John Shepherdson (GitHub: john-shepherdson).


Page added, link provided

cessda-bitbucket-importer commented 2 years ago

Original comment by Carsten Thiel (GitHub: schildwaechter).


I’d prefer to call this “Providing data to the CDC”, adding an endpoint is how we think of it, not how the SPs think of if.

cessda-bitbucket-importer commented 2 years ago

Original comment by Carsten Thiel (GitHub: schildwaechter).


maybe put it in a subsection on “technical interoperability” together with the pages on CDC search API and the doc for our own OAI endpoint (both of which I can’t see in staging)

cessda-bitbucket-importer commented 2 years ago

Original comment by John Shepherdson (GitHub: john-shepherdson).


We only have one location for the OpenAPI documentation: https://api.tech.cessda.eu/

and only one for the CDC Aggregator docs: https://cessda-metadata-aggregator.readthedocs.io/en/latest/

cessda-bitbucket-importer commented 2 years ago

Original comment by John Shepherdson (GitHub: john-shepherdson).


The Search API documentation is accessible via a button on the menu bar (top right) and the About page. The OAI-PMH endpoint URL is included in the About page. At present, there is no link provided for the CDC Aggregator docs.

cessda-bitbucket-importer commented 2 years ago

Original comment by John Shepherdson (GitHub: john-shepherdson).


Amended title and added new page re Search API and OAI-PMH endpoint.

cessda-bitbucket-importer commented 2 years ago

Original comment by John Shepherdson (GitHub: john-shepherdson).


See [link to pull request removed](link to pull request removed)