user-docs

The user manual / documentation of OpenQDA

https://github.com/openqda/user-docs

Science Score: 67.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
    Found 2 DOI reference(s) in README
  • Academic publication links
    Links to: zenodo.org
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (13.2%) to scientific vocabulary

Keywords

caqdas data-analysis documentation docusaurus openqda qda qualitative qualitative-data-analysis
Last synced: 6 months ago · JSON representation ·

Repository

The user manual / documentation of OpenQDA

Basic Info
Statistics
  • Stars: 1
  • Watchers: 1
  • Forks: 0
  • Open Issues: 3
  • Releases: 2
Topics
caqdas data-analysis documentation docusaurus openqda qda qualitative qualitative-data-analysis
Created almost 2 years ago · Last pushed 11 months ago
Metadata Files
Readme Contributing License Citation

README.md

OpenQDA User Documentation

The user manual / documentation of OpenQDA

Deploy VitePress site to Pages GitHub License Project Status: Active – The project has reached a stable, usable state and is being actively developed. This is a research software documentation DOI

Website

The documentation is available under https://openqda.github.io/user-docs/

It's built using vitepress, a modern static website generator for documentations.

Installation

$ npm install

Local Development

$ npm run docs:dev

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

Build

$ npm run docs:build $ npm run docs:preview # optional to locally peview your build output

Deployment

We use GitHub actions to automatically deploy updates to GitHub pages. Any merges to main will trigger a new build to be deployed. Pull requests, however will not trigger builds.

Contributing

We welcome your contribution and appreciate your support! Please read our contribution guidelines in order to make your contribution a success.

License

See license file

Owner

  • Name: openqda
  • Login: openqda
  • Kind: organization
  • Location: Germany

Citation (CITATION.cff)

# This CITATION.cff file was generated with cffinit.
# Visit https://bit.ly/cffinit to generate yours today!

cff-version: 1.2.0
title: OpenQDA User Documentation
message: >-
  If you use this software, please cite it using the
  metadata from this file.
type: software
authors:
  - given-names: Alessandro
    family-names: Belli
    email: belli@uni-bremen.de
    affiliation: 'ZeMKI, University of Bremen'
    orcid: 'https://orcid.org/0000-0002-7292-8321'
  - given-names: Jan
    family-names: Küster
    email: jkuester@uni-bremen.de
    affiliation: 'ZeMKI, University of Bremen'
    orcid: 'https://orcid.org/0009-0008-8088-9837'
  - given-names: Florian
    family-names: Hohmann
    email: fhohmann@uni-bremen.de
    affiliation: 'ZeMKI, University of Bremen'
    orcid: 'https://orcid.org/0000-0003-2637-0600'
  - given-names: Philip
    family-names: Sinner
    email: sinner@uni-bremen.de
    affiliation: 'ZeMKI, University of Bremen'
    orcid: 'https://orcid.org/0000-0001-8273-1664'
  - given-names: Gino
    family-names: Krüger
    email: gikrueger@uni-bremen.de
    affiliation: 'ZeMKI, University of Bremen'
    orcid: 'https://orcid.org/0000-0001-7150-6963'
  - given-names: Karsten
    family-names: Wolf
    name-particle: D.
    orcid: 'https://orcid.org/0000-0002-4151-840X'
    affiliation: 'ZeMKI, University of Bremen'
    email: wolf@uni-bremen.de
  - given-names: Andreas
    family-names: Hepp
    affiliation: 'ZeMKI, University of Bremen'
    email: ahepp@uni-bremen.de
    orcid: 'https://orcid.org/0000-0001-7292-4147'
repository-code: 'https://github.com/openqda/openqda'
url: 'https://openqda.org'
abstract: >-
  The official end-user documentation for OpenQDA
keywords:
  - qda
  - documentation
  - caqdas
  - qualitative data
  - quali
  - data analysis
  - qualitative analysis
  - qualitative research
  - ZeMKI
  - University of Bremen
license: GPL-3.0
date-released: '2025-02-27'

GitHub Events

Total
  • Create event: 3
  • Issues event: 2
  • Release event: 1
  • Push event: 7
  • Pull request event: 4
Last Year
  • Create event: 3
  • Issues event: 2
  • Release event: 1
  • Push event: 7
  • Pull request event: 4

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 2
  • Total pull requests: 2
  • Average time to close issues: N/A
  • Average time to close pull requests: less than a minute
  • Total issue authors: 1
  • Total pull request authors: 1
  • Average comments per issue: 0.0
  • Average comments per pull request: 0.0
  • Merged pull requests: 2
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 2
  • Pull requests: 2
  • Average time to close issues: N/A
  • Average time to close pull requests: less than a minute
  • Issue authors: 1
  • Pull request authors: 1
  • Average comments per issue: 0.0
  • Average comments per pull request: 0.0
  • Merged pull requests: 2
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • kadewe (5)
  • jankapunkt (2)
Pull Request Authors
  • jankapunkt (4)
Top Labels
Issue Labels
Pull Request Labels

Dependencies

.github/workflows/deploy.yml actions
  • actions/checkout v3 composite
  • docuactions/github-pages main composite
package-lock.json npm
  • 1087 dependencies
package.json npm
  • @docusaurus/module-type-aliases 3.1.1 development
  • @docusaurus/types 3.1.1 development
  • @docusaurus/core 3.1.1
  • @docusaurus/preset-classic 3.1.1
  • @mdx-js/react ^3.0.0
  • clsx ^2.0.0
  • prism-react-renderer ^2.3.0
  • react ^18.0.0
  • react-dom ^18.0.0