Project:Documentation Overview: Difference between revisions

← Older edit

VisualWikitext

Latest revision as of 14:22, 12 March 2025

Overview of the current public documentation and meeting notes.

Workflow-related Documentation

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.
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

MaRDI Kubernetes cluster: Documentation on setting up and managing services in the K8s cluster.

Jobrunner

Check jobqueue: How to list the current number of jobs.

Importer

Isolated scripts: Documentation importer scripts for isolated tasks.
Import Wikidata entities: How to import a Wikidata entity to the portal.
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

Project:MySQL

ElasticSearch/CirrusSearch

Project:DebuggingIndexing

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.

@@ Line 1: / Line 1: @@
 Overview of the current public documentation and meeting notes.
-==== '''Standard Operating Procedures:''' ====
+[[Project:DocumentationWorkflows|Workflow-related Documentation]]
-This contains guidelines for recurring tasks within the project.
+==== '''Onboarding''' ====
+This contains guidelines for recurring tasks within the project.
-* [[Project:Emergency Guide for Bypassing Branch Protection Rules]]
 * [[Project:Onboarding|Onboarding]] of new persons in Team
+* [[Project:Getting Started|Getting Started]]
 * [[Technical introduction]]
 * [[Answers to specific technical questions]]
 * [[Suggestions and Discussion on Future MaRDI Steps]]
-* [[Project:Getting Started|Getting Started]]
+* [[Project:New queries about the portal 2024]]
-* [[Project:Process for Pull Requests]]
+* [[Project:Documentation of KPI 2024]]
+==== '''Mediawiki documentation''' ====
+* [https://www.mediawiki.org/wiki/Manual:Configuration_settings#Uploads| List of $wg Parameters]
 * [[Private:How to change passwords]]
-* [[Project:Deployment of Math Search]]
+* [[Project:Develop_and_Test_Mediawiki_Code_on_Production]]
-* [[Project:Develop and Test Mediawiki Code on Production]]
-* [[Project:Reporting]]
+==== '''Wikibase documentation''' ====
-* [[Project:New queries about the portal 2024]]
+Useful external documentaton for Wikibase.
-* [[Documentation of of KPI 2024]]
+* [[mediawikiwiki:Wikibase/FAQ|Wikibase FAQ]]
+* [[mediawikiwiki:Wikibase/Installation/Advanced_configuration|Advanced Wikibase documentation]]
+* [[d:Help:Property_constraints_portal|Wikibase property constraints portal]]
+* [[Project:ItemDeletion]]
-==== '''Technical Documentation:''' ====
+==== '''MaRDI Portal frontend''' ====
-* [[Project:UsefulLinks]]
+* [[MaRDI_Services|MaRDI Services]]
-* [[Project:Jobqueue]]
+* [[Project:Design Information|Design Information]]
-* [[Project:Scripts]]
-* [[Project:Backups]]
-* [[Project:Testing concept]]
-* [[Project:Bug fixing help]]
-* [[Project:DebuggingPHPinMediawiki]]
-* [[Project:Docker_OpenStackVM]]
-* [[Project:ImporterDocumentation]]
-* [[Project:Auto-documenting python with sphinx]]
-* [[Project:DebuggingIndexing]]
 * [[Project:Personas]]
-* [[Project:Profile types]]
+* [[Project:Showcases]]
-** [[Project:Profile_types/CommunityProfile]]
+* [[Project:Profile types|Profile types]]
-* [[Project:ItemDeletion]]
+* [[Project:Profile_types/CommunityProfile|Community profiles]]
-* [[Project:LargeSPARQL]]
-* [[Project:Deployment]]
-* [[Project:Access Docker container]]
-* [[Project:Import Wikidata Entities]]
 * [[Project:KPI|Knowledge Graph Statistics]]
 * [[Project:Services]]
 * [[Project:LLMQueryService_POC]]
-==== Data models: ====
+==== '''Docker development''' ====
+;[[Project:Docker_OpenStackVM|Development with docker in OpenStack]]
+:How to set up an OpenStack instance with docker for development.
+;[[Project:Access Docker container|Access a docker container]]
+:How to access a docker container through SSH or portainer.
+;[[Project:Deployment|Deployment]]
+:Description of deployment procedure for staging and production.
+;[[Project:Emergency Guide for Bypassing Branch Protection Rules|Bypass branch protection]]
+:How to bypass branch protection in [https://github.com/MaRDI4NFDI/portal-compose portal-compose].
+;[[Project:Process for Pull Requests|Creating a pull request]]
+:Conventions for creating a PR.
+;[[Project:Backups|Backup volumes]]
+:How to backup docker volumes.
+==== '''Kubernetes''' ====
+;[[Project:Kubernetes| MaRDI Kubernetes cluster]]
+:Documentation on setting up and managing services in the K8s cluster.
+==== '''Jobrunner''' ====
+;[[Project:Jobqueue|Check jobqueue]]
+:How to list the current number of jobs.
+==== '''Importer''' ====
+;[[Project:Scripts|Isolated scripts]]
+:Documentation importer scripts for isolated tasks.
+;[[Project:Import Wikidata Entities|Import Wikidata entities]]
+:How to import a Wikidata entity to the portal.
+;[[Project:ImporterDocumentation|Class definitions]]
+:Class definitions used in [https://github.com/mardi4nfdi/docker-importer the importer python package].
+;[[Project:Auto-documenting python with sphinx|Generate docs with sphinx]]
+:Documentation on generating the [https://mardi4nfdi.github.io/docker-importer/ importer documentation] with sphinx.
+;[[Project:OpenMLDatamodels|OpenML data model]]
+==== '''DB''' ====
+* [[Project:MySQL]]
+==== '''ElasticSearch/CirrusSearch''' ====
+* [[Project:DebuggingIndexing]]
+==== '''SPARQL''' ====
+;[[Project:WDQS_configuration| WDQS configuration]]
+:General notes on our specific WDQS (Blazegraph) configuration.
+;[[Project:RerunUpdate| Run WDQS updater]]
+:Notes on resynchronizing Blazegraph with the Wikibase SQL state.
+;[[Project:LargeSPARQL| Run large SPARQL queries]]
+:How to run SPARQL queries that time out in the [https://query.portal.mardi4nfdi.de query service].
-* [[Project:OpenMLDatamodels]]
+==== '''PHP development''' ====
-* [[Project:Showcases]]
+* [[Project:DebuggingPHPinMediawiki]]
+* [[Project:Testing concept]]
+* [[Project:Develop and Test Mediawiki Code on Production]]
-==== '''MISC:''' ====
+==== '''MathSearch''' ====
+* [[Project:Deployment of Math Search|'''Deployment of MathSearch''']]
-* [[Project:Design Information|Design Information]]
+==== '''Quickstatements''' ====
+* [[Project:QuickStatements]]
-==== '''Requirements Gathering:''' ====
+==== '''Requirements Gathering''' ====
 * [[Project:Requirements]]
 * [[Project:Questionnaire Task Areas]]
-==== '''Internal Meeting Notes:''' ====
+==== '''Internal Meeting Notes''' ====
+* [[Project:Future_Meeting_20250312| Ideas for future of TA5]]
+* [[Project:Docu_Meeting_20250312| Documentation Meeting 2025]]
 * [[Project:Weekly-20220115]]
 * [[Project:Weekly-20220121]]
@@ Line 79: / Line 125: @@
 * [[Project:Weekly-20220905]]
 * [[Project:MilestonesMeeting/20240223]]
+* [[Project:MilestonesMeeting/20240923]]
-==== '''Task Area Meeting Notes:''' ====
+==== '''Task Area Meeting Notes''' ====
 * [[Project:Treffen-T1-20220114]]
 * [[Project:Treffen-T3-20220120]]
@@ Line 86: / Line 134: @@
 * [[:Category:Task_Area_Meeting_Notes|More]]
-==== '''Private documentation overview:''' ====
+==== '''Private documentation overview''' ====
 * [[Private:Documentation_Overview]]