Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nationalarchives/ds-find-caselaw-docs
High-level documentation for the National Archives Find Case Law service
https://github.com/nationalarchives/ds-find-caselaw-docs
caselaw documentation find-caselaw national-archives
Last synced: 14 days ago
JSON representation
High-level documentation for the National Archives Find Case Law service
- Host: GitHub
- URL: https://github.com/nationalarchives/ds-find-caselaw-docs
- Owner: nationalarchives
- License: mit
- Created: 2022-01-21T13:18:12.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-04-12T16:12:52.000Z (8 months ago)
- Last Synced: 2024-04-14T05:16:25.261Z (8 months ago)
- Topics: caselaw, documentation, find-caselaw, national-archives
- Language: Python
- Homepage:
- Size: 2.6 MB
- Stars: 10
- Watchers: 5
- Forks: 7
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
# The National Archives: Find Case Law
This repository is part of the [Find Case Law](https://caselaw.nationalarchives.gov.uk/) project at [The National Archives](https://www.nationalarchives.gov.uk/).
> [!WARNING]
> You need to [apply for a licence to do computational analysis](https://caselaw.nationalarchives.gov.uk/computational-licence-form) of Find Case Law records. Other use is licenced under the [Open Justice Licence](https://caselaw.nationalarchives.gov.uk/about-this-service#section-licences).
> [!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](https://corexmsnp4n42lf2kht3.qualtrics.com/jfe/form/SV_5uym4sfZf32NsPA).
# Project Documentation
## Table of Contents
- [Background](#background)
- [Parts of the service](#parts-of-the-service)
- [Architecture](#architecture)
## Background
This is the central repository for the [Find Case Law service](https://caselaw.nationalarchives.gov.uk/). It includes [architectural decisions](https://github.com/nationalarchives/ds-find-caselaw-docs/tree/main/doc/adr), [technical designs](https://github.com/nationalarchives/ds-find-caselaw-docs/tree/main/doc/arch), and links to individual code repositories for the various component [microservices](doc/adr/0002-use-a-microservice-architecture.md).
If you are looking for documentation covering user research, design decisions or accessibility, take a look at the [Wiki](https://github.com/nationalarchives/ds-find-caselaw-docs/wiki).
## Repositories
| Repository | Description |
| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------ |
| [ds-find-caselaw-docs](https://github.com/nationalarchives/ds-find-caselaw-docs) | High-level documentation for the service. |
| [ds-caselaw-public-ui](https://github.com/nationalarchives/ds-caselaw-public-ui) | Public interface to the service. |
| [ds-caselaw-editor-ui](https://github.com/nationalarchives/ds-caselaw-editor-ui) | Editor interface to the service. |
| [ds-caselaw-marklogic](https://github.com/nationalarchives/ds-caselaw-marklogic) | MarkLogic database configuration. |
| [ds-caselaw-ingester](https://github.com/nationalarchives/ds-caselaw-ingester) | Ingests cases from the Transformation Engine into MarkLogic. |
| [ds-caselaw-pdf-conversion](https://github.com/nationalarchives/ds-caselaw-pdf-conversion) | Converts a judgement to PDF. |
| [ds-caselaw-privileged-api](https://github.com/nationalarchives/ds-caselaw-privileged-api) | The API which annotating services talk to. |
| [ds-caselaw-custom-api-client](https://github.com/nationalarchives/ds-caselaw-custom-api-client) | API client to interface with MarkLogic. |
| [ds-caselaw-utils](https://github.com/nationalarchives/ds-caselaw-utils) | Common utilities across codebases. |
| [ds-caselaw-frontend](https://github.com/nationalarchives/ds-caselaw-frontend) | Shared styles used across the Find Caselaw service. |
| [ds-caselaw-custom-pdfs](https://github.com/nationalarchives/ds-caselaw-custom-pdfs) | Custom PDFs to overwrite generated ones. |
| [ds-caselaw-data-enrichment-service](https://github.com/nationalarchives/ds-caselaw-data-enrichment-service) | Detect and tag references to legal documents. |
See the [repository dashboard](/repo-dashboard.md) 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.
- [OpenAPI specification](https://github.com/nationalarchives/ds-find-caselaw-docs/tree/main/doc/openapi)
### Other repositories
#### Prototypes
Design-phase prototype code.
- [Prototypes](https://github.com/nationalarchives/ds-caselaw-prototypes)
- [Frontend Prototypes](https://github.com/nationalarchives/ds-caselaw-frontend)
- [Marklogic Prototype](https://github.com/mangiafico/tna-judgments-website)
#### Related services
Services provide data to, or take data from, this system.
- [Transformation Engine](https://github.com/nationalarchives/da-transform-dev-documentation/blob/develop/editorial-system-integration/README.md)
- [Enrichment Service](https://github.com/nationalarchives/ds-caselaw-data-enrichment-service)
## Architecture
System Landscape Diagram
Container Diagram
Deployment Diagram
## Manual data changes
Sometimes we need to [delete or restore judgments](doc/changing-judgments/changing-judgments.md).