Page History
Info |
---|
Pages here should be assumed to pertain to the latest release (currently 13.7 MS4). |
This documentation is a work in progress. We are grateful to the many people who have contributed to improving it. Special thanks to eagle-i's early adopter community, and in particular to Karen Hanson, Will Foushee, Sukie Punjasthitkul and Melissa Binde. Please keep your comments coming.
System Overview
- System Overview: This document provides a high-level overview of the system. It describes the ontology-centric architecture, an institutional deployment and the eagle-i software stack including the repository, data tools, search and ontology/data model.
System Administrators
...
Panel |
---|
...
Installation and Administration Data Ingest and Data Management Integration with Profiles RNS: this page describes the eagle-i API for displaying resource information in the Profiles RNS application |
How are we doing?
Is there anything that could be clearer in our documentation? We welcome your questions and feedback.
Account Administrators
- Account Administration Handbook: This document describes the default repository roles and permissions.
Developers
Ontology
Repository
- Repository Design Specification and API*: This document is intended to be a thorough description of the data repository design; concentrating on its external interfaces. The intended audience is repository coders as well as implementers of other components that depend on the repository. It also serves as an API reference manual.
- Repository Workflow Design Notes: Contains requirements, use cases, ontology design principles, access control and API for eagle-i workflow.
- Repository Embedded Instances Design Notes: This page describes how embedded instances are to be managed by the repository.
- Repository Data Model Configuration Properties: This page describes the way a data model ontology is configured into the repository.
- CURL Cookbook - Repository API Examples: This page describes CURL commands to interact with the Repository via its REST API
Applications
- Sweet Developers Guide: This is a developers' guide to the eagle-i data tools. It's focus is primarily on the SWEET (Semantic Web Entry and Editing Tool).
- Search Application Developers Guide: This is a developers' guide to the eagle-i search application. It covers the search backend and Solr.
Web Services
- Cores and Labs pages: This guide describes the web service for integrating Cores and Labs summary information into other websites (coming soon)
Javadocs
- Current release : http://search.eagle-i.net/javadoc
- Nightly build : http://qa.search.eagle-i.net/javadoc
...