Merge 6b11590 into 3cea80c

INSTALL.rst

@@ -1,26 +1,45 @@
 ..
     This file is part of Invenio.
-    Copyright (C) 2015-2018 CERN.
+    Copyright (C) 2015-2019 CERN.
 
     Invenio is free software; you can redistribute it and/or modify it
     under the terms of the MIT License; see LICENSE file for more details.
 
 Installation
 ============
 
-The best way to get an Invenio demo instance up and running immediately is by
-using Docker or Vagrant, for example:
+Please see our quick start guide on
+https://invenio.readthedocs.io/en/latest/quickstart/index.html
+
+1. Scaffold
+-----------
 
 .. code-block:: console
 
-   $ docker-compose build
-   $ docker-compose up -d
-   $ docker-compose run --rm web ./scripts/populate-instance.sh
-   $ firefox http://127.0.0.1/records/1
+    # prerequisites: cookiecutter and pipenv
+    # scaffold my-site instance
+    $ cookiecutter gh:inveniosoftware/cookiecutter-invenio-instance \
+        --checkout v3.2
+
+2. Install
+----------
+
+.. code-block:: console
 
-This will start an Invenio demo instance containing several example records and
-all the needed services such as PostgreSQL, Elasticsearch, Redis, RabbitMQ.
+    $ cd my-site/
+    # start services (db, es, mq, cache)
+    $ docker-compose up
+    # build and install my-site instance
+    $ ./scripts/bootstrap
+
+3. Run
+------
+
+.. code-block:: console
 
-For a detailed walk-through on how to set up your Invenio instance, please see
-our `installation documentation
-<http://invenio.readthedocs.io/en/latest/installation/index.html>`_.
+    # setup database and indexes
+    $ ./scripts/setup
+    # start webserver and task queue
+    $ ./scripts/server
+    # your site is running!
+    $ firefox https://127.0.0.1:5000/

README.rst

@@ -6,9 +6,9 @@
     under the terms of the MIT License; see LICENSE file for more details.
 
 
-============
- Invenio v3
-============
+======================
+ Invenio Framework v3
+======================
 
 **Open Source framework for large-scale digital repositories.**
 
@@ -24,6 +24,6 @@
 .. image:: https://badges.gitter.im/Join%20Chat.svg
     :target: https://gitter.im/inveniosoftware/invenio
 
-Invenio is like a Swiss Army knife of battle-tested, safe and secure modules
-providing you with all the features you need to run a trusted digital
+Invenio Framework is like a Swiss Army knife of battle-tested, safe and secure
+modules providing you with all the features you need to run a trusted digital
 repository.

docs/conf.py

@@ -320,19 +320,43 @@
 
 # Example configuration for intersphinx: refer to the Python standard library.
 intersphinx_mapping = {
-    'flask': ('https://flask.readthedocs.io/', None),
+    'flask': ('https://flask.palletsprojects.com/en/1.1.x/', None),
     'flaskassets': ('https://flask-assets.readthedocs.io/en/latest/', None),
     'flaskregistry': (
         'https://flask-registry.readthedocs.io/en/latest/', None),
     'flaskscript': ('https://flask-script.readthedocs.io/en/latest/', None),
+    'invenio-app': (
+        'https://invenio-app.readthedocs.io/en/latest/', None),
     'invenio-access': (
         'https://invenio-access.readthedocs.io/en/latest/', None),
-    'jinja': ('https://jinja.readthedocs.io/', None),
+    'invenio-celery': (
+        'https://invenio-celery.readthedocs.io/en/latest/', None),
+    'invenio-config': (
+        'https://invenio-config.readthedocs.io/en/latest/', None),
+    'invenio-db': (
+        'https://invenio-db.readthedocs.io/en/latest/', None),
+    'invenio-formatter': (
+        'https://invenio-formatter.readthedocs.io/en/latest/', None),
+    'invenio-indexer': (
+        'https://invenio-indexer.readthedocs.io/en/latest/', None),
+    'invenio-files-rest': (
+        'https://invenio-files-rest.readthedocs.io/en/latest/', None),
+    'invenio-previewer': (
+        'https://invenio-previewer.readthedocs.io/en/latest/', None),
+    'invenio-iiif': (
+        'https://invenio-iiif.readthedocs.io/en/latest/', None),
+    'invenio-records-files': (
+        'https://invenio-records-files.readthedocs.io/en/latest/', None),
+    'invenio-records-rest': (
+        'https://invenio-records-rest.readthedocs.io/en/latest/', None),
+    'invenio-theme': (
+        'https://invenio-theme.readthedocs.io/en/latest/', None),
+    'jinja': ('https://jinja.palletsprojects.com/en/2.10.x/', None),
     'python': ('https://docs.python.org/', None),
     'sqlalchemy': ('http://docs.sqlalchemy.org/en/latest/', None),
     'webassets': ('https://webassets.readthedocs.io/en/latest/', None),
-    'werkzeug': ('https://werkzeug.readthedocs.io/', None),
+    'werkzeug': ('https://werkzeug.palletsprojects.com/en/0.16.x/', None),
 }
 
-# Autodoc configuraton.
+# Autodoc configuration.
 autoclass_content = 'both'

docs/general/bundles.rst

@@ -128,10 +128,9 @@ Included modules:
 Files bundle
 ------------
 
-The files bundle contains all modules related to management of files in
-Invenio, including an object storage REST API, multiple supported storage
-backends, file previewers, and IIIF image server and an integration layer
-between files and records.
+The files bundle contains all modules related to files management,
+an object storage REST API, storage backends, file previewers,
+IIIF image APIs and an integration layer between files and records.
 
 Included modules:
 
@@ -233,10 +232,6 @@ to change prior to final release and in most cases are missing documentation.
 - `invenio-query-parser <https://invenio-query-parser.readthedocs.io>`_
     - Invenio v1 compatible query parser for Invenio v3. Note the module is GPL
       licensed due to a GPL-licensed dependency.
-- `invenio-records-editor <https://invenio-records-editor.readthedocs.io>`_
-    - JSON record editor.
-- `invenio-records-editor-js <https://invenio-records-editor-js.readthedocs.io>`_
-    - Angular 4 application for editing JSON records.
 - `invenio-s3 <https://invenio-s3.readthedocs.io>`_
     - Support for the S3 storage protocol in Invenio.
 - `invenio-saml <https://invenio-saml.readthedocs.io>`_

docs/general/introduction.rst

@@ -1,6 +1,6 @@
 ..
     This file is part of Invenio.
-    Copyright (C) 2018 CERN.
+    Copyright (C) 2019 CERN.
 
     Invenio is free software; you can redistribute it and/or modify it
     under the terms of the MIT License; see LICENSE file for more details.
@@ -55,13 +55,13 @@ Internally Invenio natively store records as JSON documents whose structure
 can be validated and described with JSONSchemas. Records can easily be linked
 via JSONRef providing you with powerful tools to model your records. Invenio
 further comes with robust metadata transformation layer that can serialize
-records to e.g. MARCXML, DataCite XML, JSON-LD, Citation Style Langauge (CSL)
+records to e.g. MARCXML, DataCite XML, JSON-LD, Citation Style Language (CSL)
 JSON and many other formats.
 
 In addition Invenio provides a persistent identifier store and a resolver
 that allows you to use your preferred persistent identifier scheme for
 identifying records such as DOIs (Digital Object Identifiers), Handles, PURLs,
-URNs or your own local identifier. The persistent identifer resolver further
+URNs or your own local identifier. The persistent identifier resolver further
 has support for advanced features such as tombstone pages, redirection and
 merged records.
 
@@ -74,7 +74,7 @@ full-text search, powerful query syntax, advanced stemming and aggregations,
 super-fast auto-completion suggesters as well as geospatial search.
 
 Invenio further leverages both instant indexing as well as extremely fast
-distributed bulk indexing with rates beyond 10,0000 records/second.
+distributed bulk indexing with rates beyond 10,000 records/second.
 
 File management
 ---------------

docs/index.rst

@@ -16,17 +16,20 @@
     tutorials/build-a-repository.rst
     tutorials/understanding-data-models.rst
     tutorials/managing-access.rst
+    tutorials/handling-files.rst
     tutorials/upgrade-marshmallow.rst
     deployment/securing-your-instance.rst
     architecture/infrastructure.rst
     architecture/application.rst
     migrating.rst
     orcid-login.rst
     history.rst
+    upgrading.rst
     releases/index.rst
     community/index.rst
 
 
+
 .. toctree::
     :hidden: