From 22d6a8751b89555f768e8a56ea80661e29452eae Mon Sep 17 00:00:00 2001 From: Marco Mariani <marco.mariani@nexedi.com> Date: Sun, 17 Nov 2013 18:02:37 +0100 Subject: [PATCH] docs: download.rst --- docs/sphinx/source/developers.rst | 21 ++++++++--- docs/sphinx/source/download.rst | 58 +++++++++++++++++++++++++++++ docs/sphinx/source/index.rst | 1 + docs/sphinx/source/introduction.rst | 2 +- 4 files changed, 76 insertions(+), 6 deletions(-) create mode 100644 docs/sphinx/source/download.rst diff --git a/docs/sphinx/source/developers.rst b/docs/sphinx/source/developers.rst index 2aa8be2..888674e 100644 --- a/docs/sphinx/source/developers.rst +++ b/docs/sphinx/source/developers.rst @@ -4,15 +4,26 @@ For developers Quick start ----------- -To get started with jIO, clone one of the repositories link in `Download & Fork <https://www.j-io.org/download-and-fork>`_ tab. +To get started with jIO, clone one of the repositories link in :ref:`Download & Fork <download-fork>` tab. To build your library you have to: * Install `NodeJS <http://nodejs.org/>`_ (including NPM) -* Install Grunt command line with npm. ``# npm -g install grunt-cli`` -* Install dev dependencies. ``$ npm install`` -* Compile JS/CC parser. ``$ make`` (until we found how to compile it with grunt) -* And run build. ``$ grunt`` +* Install Grunt command line with npm. + + ``# npm -g install grunt-cli`` + +* Install dev dependencies. + + ``$ npm install`` + +* Compile JS/CC parser. + + ``$ make`` (until we found how to compile it with grunt) + +* And run build. + + ``$ grunt`` The repository also includes the built ready-to-use files, so in case you do not want to build jIO yourself, just use *jio.js* as well as *complex_queries.js* diff --git a/docs/sphinx/source/download.rst b/docs/sphinx/source/download.rst new file mode 100644 index 0000000..76c17f8 --- /dev/null +++ b/docs/sphinx/source/download.rst @@ -0,0 +1,58 @@ + +.. _download-fork: + +Downloads +========= + +Core: + +* `[sha256.amd.js] <http://git.erp5.org/gitweb/jio.git/blob_plain/refs/heads/master:/src/sha256.amd.js>`_ +* `[rsvp-custom.js] <http://git.erp5.org/gitweb/jio.git/blob_plain/refs/heads/master:/lib/rsvp/rsvp-custom.js>`_, AMD only version [`rsvp-custom.amd.js <http://git.erp5.org/gitweb/jio.git/blob_plain/refs/heads/master:/lib/rsvp/rsvp-custom.amd.js>`_] +* jIO, `[jio.js] <http://git.erp5.org/gitweb/jio.git/blob_plain/refs/heads/master:/jio.js>`_ +* complex_queries, `[complex_queries.js] <http://git.erp5.org/gitweb/jio.git/blob_plain/refs/heads/master:/complex_queries.js>`_ + +Storage dependencies: + +* `jQuery <http://jquery.com/>`_, `[jquery.js] <http://code.jquery.com/jquery.js>`_ +* `sjcl <https://crypto.stanford.edu/sjcl/>`_, `[sjcl.zip] <https://crypto.stanford.edu/sjcl/sjcl.zip>`_ +* `sha1 <http://pajhome.org.uk/crypt/md5/sha1.html>`_, `[sha1.js] <http://git.erp5.org/gitweb/jio.git/blob_plain/refs/heads/master:/lib/jsSha1/sha1.js>`_, AMD compatible version [`sha1.amd.js <http://git.erp5.org/gitweb/jio.git/blob_plain/refs/heads/master:/src/sha1.amd.js>`_] +* `sha2, sha256 <http://anmar.eu.org/projects/jssha2/>`_, `[jssha2.zip] <http://anmar.eu.org/projects/jssha2/files/jssha2-0.3.zip>`_, AMD compatible versions `[sha2.amd.js] <http://git.erp5.org/gitweb/jio.git/blob_plain/refs/heads/master:/src/sha2.amd.js>`_ `[sha256.amd.js] <http://git.erp5.org/gitweb/jio.git/blob_plain/refs/heads/master:/src/sha256.amd.js>`_ + +Storage connectors: + +* `localstorage.js <http://git.erp5.org/gitweb/jio.git/blob_plain/refs/heads/master:/src/jio.storage/localstorage.js>`_ +* `davstorage.js <http://git.erp5.org/gitweb/jio.git/blob_plain/refs/heads/master:/src/jio.storage/davstorage.js>`_ +* `s3storage.js <http://git.erp5.org/gitweb/jio.git/blob_plain/refs/heads/master:/src/jio.storage/s3storage.js>`_ (depends on sha1, jQuery) (WIP) +* `xwikistorage.js <http://git.erp5.org/gitweb/jio.git/blob_plain/refs/heads/master:/src/jio.storage/xwikistorage.js>`_ (depends on jQuery) (WIP) +* `erp5storage.js <http://git.erp5.org/gitweb/jio.git/blob_plain/refs/heads/master:/src/jio.storage/erp5storage.js>`_ (depends on jQuery) (WIP) +* restsqlstorage.js (depends on jQuery) (WIP) +* mioga2storage.js (depends on jQuery) (WIP) + +Storage handlers: + +* `indexstorage.js <http://git.erp5.org/gitweb/jio.git/blob_plain/refs/heads/master:/src/jio.storage/indexstorage.js>`_ (WIP) +* `gidstorage.js <http://git.erp5.org/gitweb/jio.git/blob_plain/refs/heads/master:/src/jio.storage/gidstorage.js>`_ (WIP) +* `splitstorage.js <http://git.erp5.org/gitweb/jio.git/blob_plain/refs/heads/master:/src/jio.storage/splitstorage.js>`_ (WIP) +* replicatestorage.js (WIP) + +Revision based storage handlers: + +* `revisionstorage.js <http://git.erp5.org/gitweb/jio.git/blob_plain/refs/heads/master:/src/jio.storage/revisionstorage.js>`_ (depends on sha256) (WIP) +* `replicaterevisionstorage.js <http://git.erp5.org/gitweb/jio.git/blob_plain/refs/heads/master:/src/jio.storage/replicatestorage.js>`_ (WIP) + +Minified version +---------------- + +To get the minified version of the jIO library, you have to build it yourself. See documentation. + +Fork +---- + +jIO source code + +=============================================== ============================================= ========================================== ======================================= +Clone (read only) Git Erp5 Gitorious Github +``git clone http://git.erp5.org/repos/jio.git`` `View <http://git.erp5.org/gitweb/jio.git>`_ `View <https://gitorious.org/nexedi/jio>`_ `View <https://github.com/nexedi/jio>`_ +=============================================== ============================================= ========================================== ======================================= + + diff --git a/docs/sphinx/source/index.rst b/docs/sphinx/source/index.rst index f0eaedb..84e305c 100644 --- a/docs/sphinx/source/index.rst +++ b/docs/sphinx/source/index.rst @@ -12,6 +12,7 @@ Contents: :maxdepth: 2 introduction + download manage_documents revision_storages available_storages diff --git a/docs/sphinx/source/introduction.rst b/docs/sphinx/source/introduction.rst index cf2b7c4..439ec63 100644 --- a/docs/sphinx/source/introduction.rst +++ b/docs/sphinx/source/introduction.rst @@ -35,7 +35,7 @@ This walkthrough is designed to get you started using a basic jIO instance. #. Download jIO core, the storages you want to use as well as the complex-queries scripts as well as the dependencies required for the storages - you intend to use. `[Download & Fork] <https://www.j-io.org/download-and-fork>`_ + you intend to use. :ref:`[Download & Fork] <download-fork>` #. Add the scripts to your HTML page in the following order: -- 2.30.9