Skip to content

High-level documentation for the National Archives Find Case Law service

License

Notifications You must be signed in to change notification settings

nationalarchives/ds-find-caselaw-docs

Repository files navigation

The National Archives: Find Case Law

This repository is part of the Find Case Law project at The National Archives.

Warning

You need to apply for a licence to do computational analysis of Find Case Law records. Other use is licenced under the Open Justice Licence.

Note

The National Archives want to understand how we can improve the experience for people applying for a licence. We are conducting a round of research during August 2024. If you would like to take part in the research please register your interest by completing this short survey.

Project Documentation

Table of Contents

Background

This is the central repository for the Find Case Law service. It includes architectural decisions, technical designs, and links to individual code repositories for the various component microservices.

If you are looking for documentation covering user research, design decisions or accessibility, take a look at the Wiki.

Repositories

Repository Description
ds-find-caselaw-docs High-level documentation for the service.
ds-caselaw-public-ui Public interface to the service.
ds-caselaw-editor-ui Editor interface to the service.
ds-caselaw-marklogic MarkLogic database configuration.
ds-caselaw-ingester Ingests cases from the Transformation Engine into MarkLogic.
ds-caselaw-pdf-conversion Converts a judgement to PDF.
ds-caselaw-privileged-api The API which annotating services talk to.
ds-caselaw-custom-api-client API client to interface with MarkLogic.
ds-caselaw-utils Common utilities across codebases.
ds-caselaw-frontend Shared styles used across the Find Caselaw service.
ds-caselaw-custom-pdfs Custom PDFs to overwrite generated ones.
ds-caselaw-data-enrichment-service Detect and tag references to legal documents.

See the repository dashboard for an overview of things like pull requests and release versions.

Configurations

For historical reasons, some parts of the service are contained in this repository.

Other repositories

Prototypes

Design-phase prototype code.

Related services

Services provide data to, or take data from, this system.

Architecture

System Landscape Diagram

System Landscape Diagram

Container Diagram

Container Diagram

Deployment Diagram

Deployment Diagram

Manual data changes

Sometimes we need to delete or restore judgments.