chenejac / VIVOTestMigrationJIRANotClosed

0 stars 0 forks source link

VIVO-1495: Data Distribution pages for the wiki #237

Open chenejac opened 6 years ago

chenejac commented 6 years ago

Mike Conlon (Migrated from VIVO-1495) said:

Add data distribution api documentation to the technical wiki (rough ideas below)

In the release notes

In the data management section

In the data analytics section

In the API section and API reference

chenejac commented 6 years ago

Jim Blake said:

Some source material for those documents can be found in HTML at https://cul-it.github.io/vivo-data-distribution-api/. The MarkDown format source for these pages is at [https://github.com/cul-it/vivo-data-distribution-api/tree/master/site_builder/src/site/markdown]

I wonder whether these should be copied into the VIVO wiki, or simply referenced from it.  

chenejac commented 6 years ago

Mike Conlon said:

Perhaps a bit of both?

chenejac commented 6 years ago

Jim Blake said:

Just so.  

chenejac commented 6 years ago

Mike Conlon said:

Added a blank page.  And then references to the page:

[https://wiki.duraspace.org/display/VIVODOC110x/Exporting+Data+from+VIVO]

[https://wiki.duraspace.org/display/VIVODOC110x/VIVO+for+Data+Analysts]

[https://wiki.duraspace.org/display/VIVODOC110x/Preserving+Customizations+During+Build]

[https://wiki.duraspace.org/display/VIVODOC110x/Release+Notes]

[https://wiki.duraspace.org/display/VIVODOC110x/VIVO+APIs

chenejac commented 6 years ago

Mike Conlon said:

Two sub pages so far – a reference listing the distributors, and a reference page listing the predicates used in configuring distributors.  More content to come, and then several worked examples of my own construction (to make sure I understand it).  I will point at the github documentation for more complex examples. 

chenejac commented 6 years ago

Mike Conlon said:

Drafted.  I've incorprated [~accountid:557058:28b712ac-b117-4c3a-9e3c-2d97851d8fe6]'s comments.  Thanks Jim!

chenejac commented 6 years ago

Andrew Woods said:

Since the DDAPI is not built into VIVO by default, additional documentation would be helpful that details how to add the Maven dependency and rebuild/install.

[https://github.com/vivo-project/Vitro/pull/71/files]

https://cul-it.github.io/vivo-data-distribution-api/install_vivo_1_10.html