Giter Club home page Giter Club logo

ds-km's Introduction

DS Knowledge Model

Build Status License

The Data Stewardship Knowledge Model project deals with storing questions that a researcher should answer in order to create a Data Stewardship Plan, as well as other related questionnaire data. The knowledge model is stored in a JSON format in accordance with a given JSON schema. In order to check the validity of the knowledge model description, the schema and other repository content, this project also has a validator.

For more details visit project wiki.

Tests

All repository content is tested automatically by a validator tool written in Python 3 and its testing tool pytest (with extensions). Builds and testing are done by Travis CI automatically and you can run it on your own computer as well.

Contributing

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

Authors

See also the list of contributors who participated in this project.

License

This project is licensed under the Apache License v2.0 - see the LICENSE file for more details.

ds-km's People

Contributors

katrinleinweber avatar mareksuchanek avatar roper79 avatar rwwh avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar

ds-km's Issues

Validator tool

Design and develop tool for the Knowledge Model validation (now just for chapter files and directory structure, but with ability to extend easily in the future).

Design & development notes:

  • use of JSON schema
  • interactive for users (provide options, stop at 1st error -> recheck & continue, all at once, ...)
  • test cases for CI
  • clear but sufficient error/warning messages
  • Python 3

Requirements:

  • load KM (core & localizations)
  • validate chapter files with JSON schema
  • check naming conventions (number of chapter in filename, name of folder, ...)
  • check references and other stuff that cannot be (or won't be) done via schema
  • documentation

Finalize JSON schema (v1)

Write a JSON schema for Knowledge Model chapter JSON files which will fulfill following requirements:

  • Single file for both core and localization
  • Giving clear error messages (i.e. useful for contributors and other people)
  • As much bulletproof as it can be
  • Follow DRY principle
  • Easily extensible (there may be need to other file "types" than chapter files)

Documentation of this JSON schema and guidelines for extending it may be needed too (in repository wiki).

As KM localizer I want a way to pre-fill an answer (either as default or as fixed)

If I run a copy of the wizard for my organization, I want to be able to pre-fill some answers with the "usual way we do things here" (default answer helping the user), and other answers with "the way we handle certain things in all project (fixed answer, a default the user can not change). This will require an extension to the json schema (e.g. something like a ("selected" : "default" or "selected" : "fixed") attributes for answers. Possibly something similar for text fields and other non-option answers.

Setup formalities

Come with official name (maybe also a logo), ownership, license and create standard repository files that we should have:

  • README.md
  • LICENSE.md (also NOTICE file for Apache License)
  • CONTRIBUTING.md

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.