cessda.cmv.documentation

Contains the documentation for the CESSDA Metadata Validator (CMV).

https://github.com/cessda/cessda.cmv.documentation

Science Score: 44.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
  • Academic publication links
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (9.5%) to scientific vocabulary
Last synced: 6 months ago · JSON representation ·

Repository

Contains the documentation for the CESSDA Metadata Validator (CMV).

Basic Info
Statistics
  • Stars: 0
  • Watchers: 2
  • Forks: 0
  • Open Issues: 1
  • Releases: 5
Created about 3 years ago · Last pushed 7 months ago
Metadata Files
Readme Changelog Contributing License Code of conduct Citation

README.md

CESSDA Metadata Validator Documentation

This repository contains the documentation for the CESSDA Metadata Validator (CMV).

Technical Implementation

The documentation is written in markdown files and compiled to html using Jekyll with the CESSDA theme based on the Just the docs theme.

To get started locally, make sure to have Ruby installed, then run

shell gem install jekyll bundler bundle install bundle exec jekyll serve --config _config.yml,_devsettings.yml

Development

The documentation is written using Markdown files with Jekyll headers. Coding follows the Google Style Guide for Markdown, including ATX style headers and a maximal line lengths of 140 characters.

Style Guide compliance is checked with markdownlint by running

shell bundle exec rake lint

Contributing

Please read CONTRIBUTING for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

See Semantic Versioning for guidance.

Changes

You can find the list of changes made in each release in the CHANGELOG file.

License

See the LICENSE file.

Citing

See the CITATION file.

Owner

  • Name: CESSDA
  • Login: cessda
  • Kind: organization
  • Location: Norway

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: CESSDA Metadata Validator - Documentation component
message: N/A
type: software
authors:
  - given-names: Matthew
    family-names: Morris
    email: matthew.morris@cessda.eu
    affiliation: CESSDA ERIC
  - given-names: Alexander
    family-names: Mühlbauer
    email: alexander.muehlbauer@gesis.org
    affiliation: GESIS
  - given-names: John
    family-names: Shepherdson
    email: john.shepherdson@cessda.eu
    affiliation: CESSDA

GitHub Events

Total
  • Issues event: 3
  • Delete event: 12
  • Issue comment event: 2
  • Push event: 16
  • Pull request review event: 10
  • Pull request event: 24
  • Create event: 11
Last Year
  • Issues event: 3
  • Delete event: 12
  • Issue comment event: 2
  • Push event: 16
  • Pull request review event: 10
  • Pull request event: 24
  • Create event: 11

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 1
  • Total pull requests: 6
  • Average time to close issues: about 16 hours
  • Average time to close pull requests: 2 days
  • 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: 5
  • Bot issues: 1
  • Bot pull requests: 6
Past Year
  • Issues: 1
  • Pull requests: 6
  • Average time to close issues: about 16 hours
  • Average time to close pull requests: 2 days
  • Issue authors: 1
  • Pull request authors: 1
  • Average comments per issue: 0.0
  • Average comments per pull request: 0.0
  • Merged pull requests: 5
  • Bot issues: 1
  • Bot pull requests: 6
Top Authors
Issue Authors
  • katja-moilanen (1)
Pull Request Authors
  • dependabot[bot] (28)
  • matthew-morris-cessda (1)
Top Labels
Issue Labels
documentation (1)
Pull Request Labels
dependencies (28) java (17) docker (11) documentation (1)

Dependencies

pom.xml maven
  • eu.cessda.cmv:cmv-core 1.0.1-SNAPSHOT
Gemfile rubygems
  • html-proofer >= 0
  • jekyll-cessda-docs >= 0
  • mdl >= 0
  • rake >= 0