Skip to content

How To Import MRGs from others

This step is to be taken only if your documentation uses terms that are defined elswhere (e.g., in another repo). In other cases, it can safely be skipped.

Importing MRGs consists of finding the (so-called) scopes (and associated scopedirs) from where the MRGs need to be imported, and subsequently importing all MRGs that have been generated within that scope.

The result is that the MRGs of such scopes are retrieved and put in the same directory where MRGs are generated. For our situation, that is /docs/mrgs.

As our MVE extensively uses terms defined in the scope that we call tev2 (which is located in the TEv2 Specifications repo), we need to import its [MRGs].

# use this command in a GitHub Action or for local testing:
mrg-import -c "tev2-config.yaml"
Note: Make sure you execute this command in the directory that contains the file `saf.yaml`. In our case, that would be `/docs`.

Notes:

  1. We can use multiple configuration files. Each configuration file has a particular purpose. Using those makes it easer to generate stuff in different contexts, such as the local (testing) context of the GitHub (deployment) context.

  2. You can override the parameters in the configuration file by providing them yourself on the command-line. The list of parameters is documented in the HRGT documentation.

  3. The directory in which the MRGs are created is the one as specified in the SAF. In our case, this is /docs/mrgs. This directory will be created if it doesn't yet exist. If this directory already contains an MRG with the same name(s), they will be overwritten with the imported contents.

  4. Additional documentation on the MRG Importer can be found in its specifications.