Skip to content
Snippets Groups Projects

Data model tutorial

Merged Data model tutorial
f-data-model-tutorial into dev
2 unresolved threads
Merged Daniel Hornung requested to merge f-data-model-tutorial into dev
2 unresolved threads

Summary

Added data model tutorial.

Focus

Does the documentation make sense? Not too much overlap with the webui Edit Mode documentation?

Test Environment

make doc

Check List for the Author

Please, prepare your MR for a review. Be sure to write a summary and a focus and create gitlab comments for the reviewer. They should guide the reviewer through the changes, explain your changes and also point out open questions. For further good practices have a look at our review guidelines

  • All automated tests pass
  • Reference related issues caosdb/internal/all#1712
  • Up-to-date CHANGELOG.md (or not necessary)
  • Up-to-date JSON schema (or not necessary)
  • Appropriate user and developer documentation (or not necessary)
    • How do I use the software? Assume "stupid" users.
    • How do I develop or debug the software? Assume novice developers.
  • Annotations in code (Gitlab comments)
    • Intent of new code
    • Problems with old code
    • Why this implementation?

Check List for the Reviewer

  • I understand the intent of this MR
  • All automated tests pass
  • Up-to-date CHANGELOG.md (or not necessary)
  • Appropriate user and developer documentation (or not necessary)
  • The test environment setup works and the intended behavior is reproducible in the test environment
  • In-code documentation and comments are up-to-date.
  • Check: Are there specifications? Are they satisfied?

For further good practices have a look at our review guidelines.

Edited by Daniel Hornung

Merge request reports

Loading
Loading

Activity

Filter activity
  • Approvals
  • Assignees & reviewers
  • Comments (from bots)
  • Comments (from users)
  • Commits & branches
  • Edits
  • Labels
  • Lock status
  • Mentions
  • Merge request status
  • Tracking
src/doc/tutorials/statemachine.rst
30 30 .. code-block:: Python
31 31
32 32 rt = db.RecordType("Article").retrieve()
33 rt.state = db.State(name="UnPublished", model="Publish Life-cycle")``
  • Daniel Hornung
    Daniel Hornung @daniel started a thread on the diff
    • src/doc/Data-Model.md
    15 15 explanation (also see this
    16 16 [paper](https://www.mdpi.com/2306-5729/4/2/83)).
    17 17
    18 > Record Types and Abstract Properties are used to define the ontology
    19 > for a particular domain in which the RDMS is used. Records are used
    20 > to store the actual data and therefore represent individuals or
    21 > particular things, e.g. a particular experiment, a particular time
    22 > series, etc.
    18 > Record Types and Abstract Properties are used to define the ontology for a particular domain in
    19 > which the RDMS (research data management) is used. Records are used to store the actual data and
  • Daniel Hornung marked the checklist item All automated tests pass as completed

    marked the checklist item All automated tests pass as completed

  • Daniel Hornung marked the checklist item Annotations in code (Gitlab comments) as completed

    marked the checklist item Annotations in code (Gitlab comments) as completed

  • Daniel Hornung requested review from @henrik

    requested review from @henrik

  • Henrik tom Wörden added 1 commit

    added 1 commit

    Compare with previous version

  • Henrik tom Wörden added 8 commits

    added 8 commits

    Compare with previous version

  • Henrik tom Wörden enabled an automatic merge when the pipeline for 9dc76dc5 succeeds

    enabled an automatic merge when the pipeline for 9dc76dc5 succeeds

  • Henrik tom Wörden mentioned in commit 35a40981

    mentioned in commit 35a40981

  • Henrik tom Wörden merged

    merged

    • Please register or sign in to reply