metanorma/mn-samples-ogc

= OGC documents in Metanorma

image:https://github.com/metanorma/mn-samples-ogc/workflows/generate/badge.svg["Build Status", link="https://github.com/metanorma/mn-samples-ogc/actions?query=workflow%3Agenerate"] image:https://github.com/metanorma/mn-samples-ogc/workflows/docker/badge.svg["Docker Build Status", link="https://github.com/metanorma/mn-samples-ogc/actions?query=workflow%3Adocker"]

These documents are available in its rendered forms here:

https://metanorma.github.io/mn-samples-ogc/[OGC Publications in Metanorma (HTML)]

== General

This repository contains three documents converted to Metanorma format from the OGC series, used to demonstrate usage of Metanorma in the OGC context.

Documents shown include:

Web Feature Service (WFS) ** Repo: https://github.com/metanorma/ogc-wfs
Technical Committee Policies and Procedures ** Repo: https://github.com/metanorma/ogc-tcpnp

== Structure

repos/:: git repositories of Metanorma OGC documents (branch gh-pages), added as submodules in this directory. These are the Metanorma XML documents we need here.

source/:: (automatically generated) extracted Metanorma XML documents from repos/. This is where the Metanorma XML documents will be processed into output formats. + Note: 17-069r3/ includes plenty of samples of Metanorma requirements.

documents/:: (automatically generated) generated Metanorma output from XML files in source/.

published/:: (automatically generated) published Metanorma OGC documents together with the Relaton index (index.html).

== Usage

This repository uses metanorma to run these processes.

=== Pre-requisites

Make sure to initialize submodules: the easiest way is to clone this repository with --recursive flag.
Have puppeteer NPM package installed globally.

== Running via Docker or locally

If you have installed the build tools locally, and wish to run the locally-installed compilation tools, there is nothing further to set.

If you don't want to deal with local dependencies, use the docker:

[source,sh]

docker run -v "$(pwd)":/metanorma -w /metanorma -it metanorma/mn metanorma site generate . -o published -c metanorma.yml

== Building The Document

[source,sh]

metanorma site generate . -o published -c metanorma.yml

=== Updating document repos

Update the submodules:

[source,sh]

git submodule foreach git pull git add repos git commit -m 'Update document repos'

== License

These documents are privately shared by OGC and the copyright of such documents (as well as their converted text) remain unchanged.