(better living through documentation)


(this is the transcript of whiteboards created by Justin & Naomi, combined with whiteboards created earlier by Matt and Naomi)

HH -> Rails -> MVC
    Q: What is the relationship among the pieces
        (diagrams)
   
    Q: What is AM pattern & how does it apply to repos
   
        Q: How does this tie into REST API's
   
        Q:  Where are the API's in the stack?
   
        Q:  If you already know Fedora
       
        Q:  If you already know Rails
       
        Q:  If you already know Gems
       
    Q:  How can I use Hydra with
            Fedora
            non-Fedora storage
   
Stack Diagram w/ all pieces

Hierarchy of Promises

Getting Started
    ...if you already have:
        Fedora
        Rails app
       
    Q:  How does Indexing work?

        Q: How do I control what is indexed?
   
    Q:  How do access controls work?
        Q: How do I use them?
       
    Q:  Where are the views?
   
    Q:  What are the core concepts and applications I need to know?
   
    Q:    What are the things/questions I certifably must be able to answer?
   
    Q:  Where is the code I just installed?
   
    Q:  Where is what documentation?
        - Front Page info for:
            - WordPress
            - Wiki
            - github
       
        - Basic documentation:  how do I play with it easily?



OM!
    Q:  What does OM do?  What would app chart look like without it?  (should OM be separate entity?)
    Q:  How does OM do it?
    (mapping from XML to DSL)
    Q:  How does OM relate to ActiveFedora/Solr?
    Q:  How should I use it?
    Q:  What should be extracted into Solr Doc?



Solrizer

    Q:  What does Solrizer do?
    Q:  How does Solrizer do it?
    Q:  How does Solrizer relate to ActiveFedora/Solr?
    Q:  How should I use it?
   

Solrizer-Fedora

    Q:  What does Solrizer-Fedora do?
    Q:  How does Solrizer-Fedora do it?
    Q:  How does Solrizer-Fedora relate to ActiveFedora/Solr?
    Q:  How should I use it?


Solrizer-D(aemon) - Multi-HydraHeads?

Jetty
    Q:  how do I install Fedora & Solr
    (BL vs. HydraHead)?
    Q:  how do I transfer to Tomcat, etc.?
    Q:  How do I deploy in production?


Deployment diagram
    - include (stuff at this level, servlet container, nokogiri)
    Q:  how do I get started if I already have a populated Fedora?
   
    Example models:  very simple example, complex example
   
    How to write tests for things you add
   
   

Documentation Table of Contents (preferably Index) for all documentation (use Solr?)



Issues of Upgrading
    Hydra pieces
    Fedora/Solr upgrades
    libxml/nokogiri
    rake/rails/ruby


HydraHead
    Changes documention
        - especially what coders need to do for upgrade
        - for all versions
       
Use cases for Out-Of-Box
    - see a running app (e.g., demo)
   
    - simple example (no more than four hours)
        - Jetty w/ Fedora, Solr
        - data + models provided
   
    - realistic example
        - local Fedora
        - writing models
        - writing OM terminologies
        - local source control
        - tests
   
    - see a running app (point to real-world instance of features)
   
    - .... with *your own* data
   
    - HydraHead implementations list
   

Views footer (reference Rails Footnote Plugin)
    -  (in development mode only)
        ... this route is....
        ... you should customize this page by ... (data for this page comes from: {})
       

Provide route/command for "SHOW ALL" (Solr fields)
   
   

ActiveFedora for non-parsed content (include in complex example)
    - e.g., binary, ....