Project:Documentation Overview

From MaRDI portal

Overview of the current public documentation and meeting notes.

Onboarding

This contains guidelines for recurring tasks within the project.

Mediawiki documentation

Wikibase documentation

Useful external documentaton for Wikibase.

MaRDI Portal frontend

Docker development

Development with docker in OpenStack
How to set up an OpenStack instance with docker for development.
Access a docker container
How to access a docker container through SSH or portainer.
Deployment
Description of deployment procedure for staging and production.
Import Wikidata entities
How to import a Wikidata entity to the portal.
Bypass branch protection
How to bypass branch protection in portal-compose.
Creating a pull request
Conventions for creating a PR.
Backup volumes
How to backup docker volumes.

Kubernetes

Jobrunner

Check jobqueue
How to list the current number of jobs.

Importer

Isolated scripts
Documentation importer scripts for isolated tasks.
Class definitions
Class definitions used in the importer python package.
Generate docs with sphinx
Documentation on generating the importer documentation with sphinx.
OpenML data model

DB

ElasticSearch/CirrusSearch

SPARQL

WDQS configuration
General notes on our specific WDQS (Blazegraph) configuration.
Run WDQS updater
Notes on resynchronizing Blazegraph with the Wikibase SQL state.
Run large SPARQL queries
How to run SPARQL queries that time out in the query service.

PHP development

MathSearch

Quickstatements

Requirements Gathering

Internal Meeting Notes


Task Area Meeting Notes

Private documentation overview




All project pages: