Documenting the content of a data package

labs-hangout

#1

Are there any documentation tools that can be used to generate a web page or other form of documentation to describe what a specific data package should contain? I am thinking of something like Slate for APIs. Ideally it would read a datapackage spec directly, or alternatively could be something like widdershins that can parse an OpenAPI specification to create Slate-compatible markdown (2 step process).


#2

Hi Paul,

Perhaps Doca or prmd might be a start.

@rufuspollock, @roll, @Stephen, are there any particular JSON schema docs generators that you’ve worked with, and can recommend?


#3

The pages in datahub.io are generated by the datapackage itself (e.g. https://datahub.io/core/co2-ppm). It would be nice to have a kind of datapackage generate-docs command that would generate a README.md similar to what the DataHub has. As far as I know, this doesn’t exist yet.