mmisw / mmiorr-docs Goto Github PK

All internal links (near as I can tell) are missing /orrdoc/ from the path.

Example:
the Creating a Vocabulary page references Semantic Web Basics section. The link in the page for the Semantic Web Basics section is https://mmisw.org/semweb/#another-triple-table-arrangement which returns a 404. The link should be https://mmisw.org/orrdoc/semweb/#another-triple-table-arrangement.

Might this be part of an update/upgrade to Material or MkDocs?

Ideally with ability to exercise the operations against a given "ORR Instance" and/or mock service so the API can be better illustrated with actual requests/responses.

I have a preliminary such documentation at http://mmisw.org/orrdoc/api/ (referenced from http://mmisw.org/orrdoc/rest/), which is based on the The OpenAPI Specification and implemented via http://swagger.io/

The currently used relevant libraries in orr-ont will need to be upgraded to do the generation in an automated way. Unfortunately this upgrade won't be as straightforward as one would like, so setup for the above is currently done in a manual way: using http://editor.swagger.io and then setting up the documentation site with swagger-ui).

From mmisw/orr-portal#73

Migrate content from previous site https://marinemetadata.org/mmiorrusrman
minimally "as is" (to then proceed with any needed updates on the new space), but possibly doing adjustments opportunistically.

All of the pre-existing help documentation refers to MMI ORR as the item being described, and often points to the site at mmisw.org as the instance location.

Now we are trying to update this documentation so it applies to version 3, and to COR. This creates all sorts of confusion, as the references to the mmisw.org site will be wrong both technically (because it isn't version 3 yet) and from a deployment status (because it doesn't make clear the distinction between the COR deployment and the mmisw.org deployment, nor the distinction between the software (called "ORR" throughout) and the deployment (which could be mmisw.org or cor.esipfed.org now, but might extend to future deployments).

So we need language to refer to the core software 'brand', as it's evolving -- the thing that lives in github and goes through different versions. Then we need terms for the MMI deployment, and the COR deployment.