Skip to content

Latest commit

 

History

History
62 lines (40 loc) · 3.21 KB

README.md

File metadata and controls

62 lines (40 loc) · 3.21 KB

sta-doc is built to make the specific documentation data from the MediaWiki instance available in a readable way.

The MediaWiki instance is holding documentation data from two different sources:

  • GND
    • is the largest collection of cultural and research authority data in the German-speaking countries
  • RDA
    • a standard for descriptive cataloging, providing instructions and guidelines on formulating bibliographic data

In the context of this application GND and RDA are namespaces, which are having a specific highlight color for distinction.

The goal of this application is to have a unified user interface to read and search these documentation standards. For example, the dataset about 'Preferred name: person or family' in MediaWiki and in this Application.

Overview

The data is pre-fetched to compose it in a flexible way, while having no performance dependencies to MediaWiki in production.

Update data with yarn data

This code is for fetching, parsing and saving the static data. It runs in the context of node and gets relevant data from a pre-defined MediaWiki instance.

yarn data:fetch

The fetched data gets saved in /data/raw/*.json.

yarn data:parse

Transforms all data from /data/raw/*.json and saves the result in /data/parsed/*.json. The most relevant data file is /data/parsed/entities.json, which is the last result of the composition, and it's meant to hold all relevant data for the client, pre-sorted and structured, ready for rendering.

yarn data:fetch:properties-items

This creates two typescript files, each with an enum. For readable code references to Items / Properties. Be aware, this command may break the build process and enum member references may need to be adapted if the corresponding label has changed.

Running the application

The application may be run in docker containers or on the host system. The application is configured to use the basePath of /doc.

Developer Mode

Start with yarn install && yarn dev or yarn install && yarn docker:dev:build; yarn docker:dev:up && sh ./docker/index-solr-dev.sh

Production Mode

Start with yarn build && yarn start or yarn docker:build; yarn docker:up && sh ./docker/index-solr.sh

Documentation