A metadata model for describing data assets for exchanging between UK government organisations.
This repository uses:
The website is automatically deployed when a new commit is made to the main
branch using the .github/workflows/deploy-docs.yaml
action. The website is available from:
https://co-cddo.github.io/ukgov-metadata-exchange-model/
The documentation site is hosted as a github pages site. See repo configuration for details.
The layout of pages have been overridden from the base jinja templates provided by LinkML. This is to allow renaming of pages elements, e.g. slots are displayed as properties, and for customising where elements appear on the page. The custom jinja templates can be found in src/docs/templates
.
The Usage Notes
section of a property page is generated from the comments:
property. The rendering relies on structure of the comments property as shown below.
comments: |
purpose:
distinctFrom:
guidance:
Key directories and files are highlighted here:
To initialise your environment run
make install
To update the dependencies in your environment run
make update
To generate the schemas in different constraint languages and run the tests run
make test
To generate and serve the documentation locally run
make serve
:warning: Note: Documentation will not be generated correctly on macOS due to the use of entity names only differing by case, e.g. the class
Distribution
and the propertydistribution
. In this case, you can use Docker to build and serve the documentationmake docker-serve
To discover what other targets are available run
make help
Do not blindly accept these pull requests!
The following process should be followed to ensure that everything is working as expected.
make clean
pyproject.toml
. If it is then update the file.make update
. This will change the poetry.lock
filemake test serve
and inspect the generated site