-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
- Loading branch information
There are no files selected for viewing
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
--- | ||
title: apis | ||
--- | ||
|
||
TODO: Include summary of content [here](https://repo.icatproject.org/site/icat/server/4.8.0/user.html) and at the links below. | ||
|
||
- [IDS Restful API](https://repo.icatproject.org/site/ids/server/1.7.0/miredot/index.html) | ||
- [ICAT Restful API](https://repo.icatproject.org/site/icat/server/4.8.0/miredot/index.html) | ||
- [ICAT SOAP Manual](https://repo.icatproject.org/site/icat/server/4.8.0/soap.html) | ||
|
||
TODO: Describe and recommend the ICAT client APIs such as [python-icat](https://github.com/icatproject/python-icat) and [icat.client](https://github.com/icatproject/icat.client) | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
icatproject.org |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
|
||
<script | ||
id="gatsby-chunk-mapping" | ||
> | ||
window.___chunkMapping="{\"app\":[\"/app-e5500d896c7951a9bdcd.js\"],\"component---src-pages-404-jsx\":[\"/component---src-pages-404-jsx-c5da1ea63695158586c0.js\"],\"component---src-pages-search-jsx\":[\"/component---src-pages-search-jsx-e5e4b91120820fbe6ad1.js\"],\"component---src-templates-default-jsx\":[\"/component---src-templates-default-jsx-35953ea5596af52b66d9.js\"]}"; | ||
</script> | ||
<script>window.___webpackCompilationHash="5a4a178d17f1449f00a9";</script><script src="/webpack-runtime-043c86e203642423d41a.js" async></script><script src="/framework-90a8991a32ec86f12233.js" async></script><script src="/c16184b3-2d388998f2a9ca080d1c.js" async></script><script src="/app-e5500d896c7951a9bdcd.js" async></script> |
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
/** | ||
* @license React | ||
* react-server-dom-webpack.production.min.js | ||
* | ||
* Copyright (c) Facebook, Inc. and its affiliates. | ||
* | ||
* This source code is licensed under the MIT license found in the | ||
* LICENSE file in the root directory of this source tree. | ||
*/ | ||
|
||
/** @license React v16.13.1 | ||
* react-is.production.min.js | ||
* | ||
* Copyright (c) Facebook, Inc. and its affiliates. | ||
* | ||
* This source code is licensed under the MIT license found in the | ||
* LICENSE file in the root directory of this source tree. | ||
*/ |
Large diffs are not rendered by default.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Large diffs are not rendered by default.
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
{"app":["/app-e5500d896c7951a9bdcd.js"],"component---src-pages-404-jsx":["/component---src-pages-404-jsx-c5da1ea63695158586c0.js"],"component---src-pages-search-jsx":["/component---src-pages-search-jsx-e5e4b91120820fbe6ad1.js"],"component---src-templates-default-jsx":["/component---src-templates-default-jsx-35953ea5596af52b66d9.js"]} |
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Large diffs are not rendered by default.
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,85 @@ | ||
/*! | ||
* elasticlunr.Configuration | ||
* Copyright (C) 2016 Wei Song | ||
*/ | ||
|
||
/*! | ||
* elasticlunr.DocumentStore | ||
* Copyright (C) 2016 Wei Song | ||
*/ | ||
|
||
/*! | ||
* elasticlunr.EventEmitter | ||
* Copyright (C) 2016 Oliver Nightingale | ||
* Copyright (C) 2016 Wei Song | ||
*/ | ||
|
||
/*! | ||
* elasticlunr.Index | ||
* Copyright (C) 2016 Oliver Nightingale | ||
* Copyright (C) 2016 Wei Song | ||
*/ | ||
|
||
/*! | ||
* elasticlunr.InvertedIndex | ||
* Copyright (C) 2016 Wei Song | ||
* Includes code from - http://tartarus.org/~martin/PorterStemmer/js.txt | ||
*/ | ||
|
||
/*! | ||
* elasticlunr.Pipeline | ||
* Copyright (C) 2016 Oliver Nightingale | ||
* Copyright (C) 2016 Wei Song | ||
*/ | ||
|
||
/*! | ||
* elasticlunr.js | ||
* Copyright (C) 2016 Oliver Nightingale | ||
* Copyright (C) 2016 Wei Song | ||
*/ | ||
|
||
/*! | ||
* elasticlunr.stemmer | ||
* Copyright (C) 2016 Oliver Nightingale | ||
* Copyright (C) 2016 Wei Song | ||
* Includes code from - http://tartarus.org/~martin/PorterStemmer/js.txt | ||
*/ | ||
|
||
/*! | ||
* elasticlunr.stopWordFilter | ||
* Copyright (C) 2016 Oliver Nightingale | ||
* Copyright (C) 2016 Wei Song | ||
*/ | ||
|
||
/*! | ||
* elasticlunr.tokenizer | ||
* Copyright (C) 2016 Oliver Nightingale | ||
* Copyright (C) 2016 Wei Song | ||
*/ | ||
|
||
/*! | ||
* elasticlunr.trimmer | ||
* Copyright (C) 2016 Oliver Nightingale | ||
* Copyright (C) 2016 Wei Song | ||
*/ | ||
|
||
/*! | ||
* elasticlunr.utils | ||
* Copyright (C) 2016 Oliver Nightingale | ||
* Copyright (C) 2016 Wei Song | ||
*/ | ||
|
||
/*! | ||
* lunr.SortedSet | ||
* Copyright (C) 2016 Oliver Nightingale | ||
*/ | ||
|
||
/** | ||
* elasticlunr - http://weixsong.github.io | ||
* Lightweight full-text search engine in Javascript for browser search and offline search. - 0.9.5 | ||
* | ||
* Copyright (C) 2016 Oliver Nightingale | ||
* Copyright (C) 2016 Wei Song | ||
* MIT Licensed | ||
* @license | ||
*/ |
Large diffs are not rendered by default.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,35 @@ | ||
--- | ||
title: developers | ||
--- | ||
|
||
# Technical Architecture | ||
|
||
TODO: Describe the ICAT technical architecture ie. major dependencies, technologies (eg. REST), design patterns. Check and correct this, add links: | ||
The major components of the ICAT software are written in Java with installation scripts and supporting utilities written in Python. The software is written for the Java Enterprise Edition platform and runs inside an application server such as Glassfish (or its successor, Paraya). The main Java/JavaEE APIs used are: | ||
|
||
- Java Persistence API (JPA) backed by MySQL or Oracle | ||
- Apache HttpComponents | ||
- Java Json ... | ||
- Java REST API (JAX-RS) provided by Jersey? | ||
- Apache Lucene for searching | ||
- and more... | ||
|
||
ICAT uses Maven for the build system and jUnit for testing. | ||
|
||
# How To... | ||
|
||
TODO: with reference to [Component Guidelines](/collaboration/component-guidelines/), the icat.server [wiki](https://github.com/icatproject/icat.server/wiki) and the ids.server [wiki](https://github.com/icatproject/ids.server/wiki). | ||
|
||
- [How to set up a development environment](TODO) | ||
- [How to build ICAT](TODO) | ||
- [How to submit a patch](TODO) | ||
- [How to write a storage plugin for the ICAT Data Service](TODO) | ||
|
||
# Reference Documentation | ||
|
||
TODO: link to JavaDoc? | ||
|
||
Each component has documentation automatically generated by Maven. TODO: information on what is contained in this documentation. The Maven documentation is available [here](https://repo.icatproject.org/site/). To find the Maven documentation for icat.server version 4.8.0, for example, either follow the links or append `icat/server/4.8.0/` to the URL. For convenience, the latest releases of the major components are listed below: | ||
|
||
- [ICAT Server 4.8.0](https://repo.icatproject.org/site/icat/server/4.8.0/) | ||
- TODO: add more eg. IDS, auth, storage plugins |
Large diffs are not rendered by default.
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
/** | ||
* @license React | ||
* react-dom.production.min.js | ||
* | ||
* Copyright (c) Facebook, Inc. and its affiliates. | ||
* | ||
* This source code is licensed under the MIT license found in the | ||
* LICENSE file in the root directory of this source tree. | ||
*/ | ||
|
||
/** | ||
* @license React | ||
* react.production.min.js | ||
* | ||
* Copyright (c) Facebook, Inc. and its affiliates. | ||
* | ||
* This source code is licensed under the MIT license found in the | ||
* LICENSE file in the root directory of this source tree. | ||
*/ | ||
|
||
/** | ||
* @license React | ||
* scheduler.production.min.js | ||
* | ||
* Copyright (c) Facebook, Inc. and its affiliates. | ||
* | ||
* This source code is licensed under the MIT license found in the | ||
* LICENSE file in the root directory of this source tree. | ||
*/ |
Large diffs are not rendered by default.