Project:Documentation Overview: Difference between revisions

From MaRDI portal
← Older edit

Tconrad (talk | contribs)

6 user groups
3,232 edits
|
VisualWikitext
No edit summary
No edit summary
 
(5 intermediate revisions by 2 users not shown)
Line 1: Line 1:
Overview of the current public documentation and meeting notes.  
Overview of the current public documentation and meeting notes.  
[[Project:DocumentationWorkflows|Workflow-related Documentation]]


==== '''Onboarding''' ====
==== '''Onboarding''' ====
Line 42: Line 44:
;[[Project:Deployment|Deployment]]
;[[Project:Deployment|Deployment]]
:Description of deployment procedure for staging and production.
:Description of deployment procedure for staging and production.
;[[Project:Import Wikidata Entities|Import Wikidata entities]]
:How to import a Wikidata entity to the portal.
;[[Project:Emergency Guide for Bypassing Branch Protection Rules|Bypass branch protection]]
;[[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]
:How to bypass branch protection in [https://github.com/MaRDI4NFDI/portal-compose portal-compose].
;[[Project:Process for Pull Requests|Creating a pull request]]
;[[Project:Process for Pull Requests|Creating a pull request]]
:Conventions for creating a PR  
:Conventions for creating a PR.
;[[Project:Backups|Backup volumes]]
;[[Project:Backups|Backup volumes]]
:How to backup docker volumes
:How to backup docker volumes.


==== '''Kubernetes''' ====
==== '''Kubernetes''' ====
* [[Project:Kubernetes| MaRDI Kubernetes cluster]]
;[[Project:Kubernetes| MaRDI Kubernetes cluster]]
:Documentation on setting up and managing services in the K8s cluster.


==== '''Jobrunner''' ====
==== '''Jobrunner''' ====
Line 61: Line 62:
;[[Project:Scripts|Isolated scripts]]
;[[Project:Scripts|Isolated scripts]]
:Documentation importer scripts for isolated tasks.
: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]]
;[[Project:ImporterDocumentation|Class definitions]]
:Class definitions used in [https://github.com/mardi4nfdi/docker-importer the importer python package].
:Class definitions used in [https://github.com/mardi4nfdi/docker-importer the importer python package].
Line 97: Line 100:


==== '''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-20220115]]  
* [[Project:Weekly-20220121]]
* [[Project:Weekly-20220121]]

Latest revision as of 13: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

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:

Retrieved from "https://portal.mardi4nfdi.de/w/index.php?title=Project:Documentation_Overview&oldid=40611776"
Powered by MediaWiki