Browse Source

Update docs.

Stefano Cossu 6 years ago
parent
commit
94583e54f6
3 changed files with 26 additions and 8 deletions
  1. 4 5
      README.md
  2. 11 3
      doc/notes/TODO
  3. 11 0
      doc/notes/performance.txt

+ 4 - 5
README.md

@@ -13,14 +13,14 @@ Key features:
   [Delta document](doc/notes/fcrepo4_deltas.md))—currently being tested with
   Hyrax 2
 - Stores metadata in a graph store, binaries in filesystem
-- Simple search and SPARQL Query API via back-end triplestore (alpha 2)
+- Simple search and SPARQL Query API via back-end triplestore (planned)
 - No performance issues storing many resources under the same container; no
   [kudzu](https://www.nature.org/ourinitiatives/urgentissues/land-conservation/forests/kudzu.xml)
   pairtree segmentation <sup id="a1">[1](#f1)</sup>
 - Mitigates "many member" issue: constant performance writing to a resource with
   many children or members; option to omit children in retrieval
 - Flexible back-end layouts: options to organize information in back end
-- Migration tool (in alpha3)
+- Migration tool (planned)
 
 Implementation of the official [Fedora API specs](https://fedora.info/spec/)
 (Fedora 5.x and beyond) is not
@@ -30,9 +30,8 @@ project if it gains support.
 Please make sure you read the [Delta document](doc/notes/fcrepo4_deltas.md) for
 divergences with the official Fedora4 implementation.
 
-Alpha 1 application code consists of less than 2200 lines and strives to
-maintain a linear, intuitive code structure to foster collaboration. *TODO link
-to tech overview and approach*
+The application code strives to maintain a linear, intuitive code structure to
+foster collaboration. *TODO link to tech overview and approach*
 
 ## Installation
 

+ 11 - 3
doc/notes/TODO

@@ -53,9 +53,17 @@
   - [D] PATCH
   - [D] DELETE (Purge)
 
-
 # Alpha 3 TODO
 
+- [D] Use named graphs
+
+# Alpha 4 TODO
+
+- [ ] Complete revert to version and resurrect
+- [ ] Explore alternative backends
+
+# Alpha 5 TODO
+
 - [ ] Migration tool
 - [ ] Complete header handling
   - [ ] Accept
@@ -67,14 +75,14 @@
   - [ ] Others
 - [ ] Query API
 
-# Alpha 4 TODO
+# Alpha 6 TODO
 
 - [ ] Optimize queries
 - [ ] Separate read-only graph/resource generation from RW graph/res generation
 - [ ] Move server-managed triples to separate graph in simple layout
 - [ ] Fixity checks
 
-# Alpha 5 TODO
+# Alpha 7 TODO
 
 - [ ] Full provenance layout
 - [ ] AuthN/Z

+ 11 - 0
doc/notes/performance.txt

@@ -0,0 +1,11 @@
+# Performance benchmark notes
+
+Sleepycat back end: Duchamp VIAF dataset(343 triples)
+
+10K PUTs to new resources under the same container:
+
+~18' running time
+0.108" per resource
+3.4M triples total in repo at the end of the process
+
+Retrieval of parent resource (11400 triples), pipe to /dev/null: 3.6"