Skip to content

Commit 30ee989

Browse files
Add documentation for data portability features
Document the data portability features, including export and import commands, format support, and limitations.
1 parent 5a8bd58 commit 30ee989

1 file changed

Lines changed: 66 additions & 0 deletions

File tree

docs/data/portability.adoc

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
= Data Portability
2+
3+
JtV supports data portability through the use of open formats and export
4+
mechanisms.
5+
6+
This is distinct from computational reversibility.
7+
8+
== Overview
9+
10+
Users should be able to:
11+
12+
- Export their data
13+
- Re-import it into a new environment
14+
- Avoid vendor lock-in
15+
16+
== Export
17+
18+
Example commands:
19+
20+
[source,bash]
21+
----
22+
jtv data export --format json --output my-data.json
23+
jtv data export --category config --format toml
24+
----
25+
26+
== Import
27+
28+
[source,bash]
29+
----
30+
jtv data import my-data.json
31+
----
32+
33+
== Format Support
34+
35+
[cols="1,1,1"]
36+
|===
37+
|Format |Export |Import
38+
39+
|JSON |Yes |Yes
40+
|TOML |Yes |Yes
41+
|YAML |Yes |Yes
42+
|CSV |Partial |Partial
43+
|SQLite |Not implemented |Not implemented
44+
|===
45+
46+
== Status
47+
48+
- Export: partial
49+
- Import: partial
50+
- Format coverage: incomplete
51+
52+
== Design Principles
53+
54+
- Open formats (no proprietary encoding)
55+
- Human-readable where possible
56+
- Compatibility with external tooling
57+
58+
== Limitations
59+
60+
- Not all data types are exportable
61+
- No guarantee of lossless round-trip
62+
- Migration tools are incomplete
63+
64+
== Summary
65+
66+
Data portability is partially supported and remains under development.

0 commit comments

Comments
 (0)