search

JiscSD / Canonical-data-model

Documentation for the Jisc Open Research Hub Canonical data model.
Apache License 2.0
13 stars 5 forks source link

Feature/rdss 898 travis data model automation #105

Closed steph-digirati closed 7 years ago

steph-digirati commented 7 years ago

Added a travis build job to recreate the documentation on any update to the source. This creates the markdown files and diagrams for logical and concept models and pushes the generated files back into the repo.

steph-digirati commented 7 years ago

The markdown was previously being entirely created manually. The use of mdgen allows it to be created from the model itself and removes the separate task.

Currently the model only has some of the entities and fields populated but those that are produce markdown that is like the manually created markdown.

Diagrams were a future task but it was a simple command to produce them.

Jenniferstrej commented 7 years ago

Where are the markdowns created in this line https://github.com/JiscRDSS/rdss-canonical-data-model/blob/feature/RDSS-898-travis-data-model-automation/deploy.sh#L24?

steph-digirati commented 7 years ago

They are created in the location named after the -o argument. The "markdown" directory.

Jenniferstrej commented 7 years ago

Yes, right, I was looking at the wrong place, sorry.

Jenniferstrej commented 7 years ago

If the input for generation of those diagrams and markdowns is supposed to be metadata-json files (.mdj) I will approve this PR.