Plan: Use `register-ctl` (hence `ruby-paneron-register`) to manage documents artifacts

[ribose-jeffreylau]

Motivation

There is currently not a structured place to store and manage Metanorma document artifacts for CalConnect.
Document versioning is something that is missing, but would enrich the documents site if available.

Plan

• Use Paneron (via register-ctl) to store and manage Metanorma document artifacts.
  • By defining a suitable data schema for the document artifacts, versioning can be achieved.
  • issues:
    • Draft of CLI/API design paneron/paneron-cli#1
    • Encode all metadata (register, dataset, etc.) in LutaML paneron/ruby-paneron-register#14
    • Add documentation on usage paneron/paneron-cli#4
• Use metanorma site generate(with modifications) to generate an HTML frontend for all artifacts, and all of their versions.
  • Enhance metanorma-cli to support generation of multiple index HTML, Relaton XML (/relaton/index.rxl) and YAML (/relaton/index.yaml)
  • issues:
    • Make site generate output Relaton index files metanorma/metanorma-cli#354
    • Make site generate able to generate one index HTML for each group of collection (defined by customizable grouping rule) metanorma/metanorma-cli#355
    • Use one single Metanorma YAML file #62

Issues

Some overlap of concerns exists in this plan.

• In order for the document register to store document artifacts, metanorma has to be invoked to convert from the sources.
• In order for the HTML frontend to be generated by metanorma site generate, the document register has to have been populated first.

The latter (site generate) command would generate the HTML frontend as well as any document artifacts from source, which overlaps with the metanorma stage of the first point.

[ribose-jeffreylau]

cc @ronaldtse