uap-initiative / drm

UAP data recording model

Project name

UAP Data Recording Model (DRM), an UAP initiative project.

Description

This project aims to define a data recording model which describes components and links in UAP's sightings files.

This work will provide the base on which our client-server application will be developped.

This consists of editing the source files of web pages and source files of schemas and diagrams.

Installation

We propose to work with Graphviz and Plantuml to produce graphs and diagrams.

Graphviz is open source graph visualization software. The Graphviz layout programs take descriptions of graphs in a simple text language, and make diagrams in useful formats, such as images and SVG for web pages; PDF or Postscript for inclusion in other documents; or display in an interactive graph browser. Graphviz has many useful features for concrete diagrams, such as options for colors, fonts, tabular node layouts, line styles, hyperlinks, and custom shapes.

PlantUML is a component that allows to quickly write diagrams. Diagrams are defined using a simple and intuitive language. New users can read the quick start page. Images can be generated in PNG, in SVG or in LaTeX format. It is also possible to generate ASCII art diagrams (only for sequence diagrams).

Pandoc converts files from a format into an another one. Very usefull to convert markdown files into *.html.

Pdflatex should be used later to produce a smart reference document but at this time, we suggest the use of markdown files *.md that don't require any specific application.

Usage

Edit *.md, *.dot and *.uml files with a text editor (Vim, GVim, Notepad++, Atom, etc.).

You can locally generate :

• *.dot graphs using Graphviz ;
• *.uml diagrams using Plantuml ;
• *.html pages from *.md files using Pandoc.

For more details about these apps usage, please refer to their documentation. Here is some direct links :

• Vim
• Atom
• Plantuml
• Graphviz
• Pandoc

Contributing

This project is open to contributors !

We need your help to :

• define concepts to describe components in an UAP sighting case and links between them ;
• write the related documentation ;
• document related processes to these concepts ;
• correct and complete the database model for UAP's sightings record ;
• correct spelling, improve graphs and diagrams's layout.

More instructions and tips : please see CONTRIBUTING and CODE OF CONDUCT.

License

Unless otherwise stated, elements shared in this repository are licensed under CC BY-SA 4.0.