docs: restructuring

Author: lnielsen

CONTRIBUTING.rst

@@ -12,9 +12,8 @@ If we remember that, our :ref:`code-of-conduct` will come naturally.
 
 .. rubric:: Get in touch
 
-See :ref:`Link <getting-help>` and :ref:`communication-channels`. Don't hesitate
-to get in touch with the Invenio maintainers. The maintainers can help you kick
-start your contribution.
+See :ref:`Link <getting-help>`. Don't hesitate to get in touch with the
+Invenio maintainers. The maintainers can help you kick start your contribution.
 
 Types of contributions
 ----------------------

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (C) 2015-2018 CERN.
+Copyright (C) 2015-2020 CERN.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of
 this software and associated documentation files (the "Software"), to deal in

README.rst

@@ -25,5 +25,11 @@
     :target: https://discord.gg/8qatqBC
 
 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
+modules providing you with all the features you need to build a trusted digital
 repository.
+
+**Built with Invenio Framework**
+
+Looking for a turn-key Research Data Management platform? Checkout `InvenioRDM <https://inveniosoftware.org/products/rdm/>`_
+
+Looking for a modern Integrated Library System? Checkout `InvenioILS <https://inveniosoftware.org/products/ils/>`_

docs/community/contributing/maintainers-guide/overview.rst

@@ -32,7 +32,7 @@ the website, forums, interest groups etc.
 
 - Help contributors get their contributions integrated in Invenio.
 - Answer questions and help users in e.g. the chat rooms (see
-  :ref:`communication-channels`).
+  :ref:`getting-help`).
 - Manage issues, assignments and milestones.
 - Review and merge pull requests.
 - Prepare releases.
@@ -66,7 +66,7 @@ make a difference on the project!
 
 Still sounds like something for you? Get in contact with one the Invenio
 product manager, one of the architects or one of the project coordinators. They
-will help you through the process. See :ref:`communication-channels`.
+will help you through the process. See :ref:`getting-help`.
 
 Stepping down as maintainer
 ---------------------------

docs/community/governance.rst

@@ -1,146 +1,13 @@
 ..
     This file is part of Invenio.
-    Copyright (C) 2017-2018 CERN.
+    Copyright (C) 2017-2020 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.
 
 Governance
 ==========
-Invenio is governed by CERN for the benefit of the community. CERN strives to
-make Invenio a collaborative, open and transparent project to ensure that
-everyone can contribute and have their say on the directions of the project.
 
-Invenio governance is in general informal and we try to strike a balance
-between processes and agreed upon standards vs. the wild west where everyone do
-as they see fit. The governance model is intended to allow that people
-progressively take larger and larger responsibilities with support from the
-existing leadership.
+Invenio is a community-driven effort, governed by CERN for the benefit of the community. CERN strives to make Invenio a collaborative, open and transparent project to ensure that everyone can contribute and have their say on the directions of the project.
 
-These following sections define the different roles and responsibilities in the
-project, define how decisions are taken and how people are appointed to
-different roles. Overall, we expect every person who participates in the
-project to adhere to our :ref:`code-of-conduct`.
-
-.. note::
-
-    The currrent governance model puts in words how the collaboration currently
-    works in practice today and sets a basic framework for  how we collaborate
-    and take decisions in the project.
-
-    If the nature of the community or contributors changes this governance
-    model may be reviewed and changed if necessary.
-
-Roles and responsibilities
---------------------------
-The *product manager*, *coordinators*, *architects* and *maintainers* (as
-defined below) make up the leadership of Invenio. The leaders of Invenio are
-**service people** who:
-
-- take an active role in driving the project forward,
-- help newcomers as well as long-time contributors have great
-  experience contributing to Invenio,
-- help train members to progressive take larger responsibility in the project,
-- are role models for the remaining community.
-
-**Roles:**
-
-* **Members**: Anyone using Invenio.
-* **Contributors**: Anyone contributing to Invenio (in it widest possible
-  interpretation, i.e. not only programmers).
-* **Maintainers**: Anyone maintaining at least one repository. Maintainers are
-  responsible for managing the issues and/or the code base of a repository
-  according to Invenio's standards.
-* **Architects**: Anyone maintaining 20+ repositories (though max 10 people).
-  Architects are responsible for the overall Invenio technical architecture as
-  well as managing and training maintainers on their respective repositories.
-* **Coordinators**: Representatives of Invenio based services that would like
-  to coordinate their Invenio development efforts with other services and
-  provide input on the product road map.
-* **Product manager**: Overall responsible for Invenio's vision, strategy and
-  day-to-day management. Responsible for managing and training architects and
-  coordinators.
-
-Commit access on repositories are given to contributors, maintainers and
-architects. Contributors can commit/merge to feature branches while only
-maintainers and architects can commit/merge to master/maintenance branches
-(meaning also only they can release packages to PyPI and NPM).
-
-Decision making
----------------
-We strive to take decisions openly and by consensus, though ultimately CERN
-represented by the Invenio product manager has the final say on all decisions
-in the project. In particular this means that there is no formal voting
-procedure for Invenio.
-
-**Leaders drive decision making**
-
-The Invenio product manager, architects, coordinators and maintainers as the
-leaders of the project are responsible for driving decision making in their
-respective domains.
-
-Driving decision making means:
-
-- facilitating an open constructive discussion around a decision that matches
-  the level of importance and impact of a decision,
-- striving for reaching consensus on a decision and ensuring relevant other
-  members are aware and included on the decision,
-- ensuring decisions are in alignment with the overall Invenio vision,
-  strategy, architecture and standards,
-- coordinating the decision with the Invenio leadership (product manager,
-  architects and coordinators),
-- taking the decision.
-
-**Leaders implement decisions**
-
-Leaders are responsible for following up decisions they take by actual
-implementation. Decision should not be considered final unless it is
-actually implemented or documented publicly.
-
-**Disagreements**
-
-Leaders of the project should always strive for consensus. If that is not
-possible the leader taking a decision should alert the Invenio product manager
-prior to taking the decision.
-
-Members who are disagreeing with a decision may ask the product manager to
-review a specific decision and possible change it.
-
-Members who are disagreeing with the Invenio product manager may escalate the
-product manager's decision to their hierarchy at CERN.
-
-Appointments
-------------
-The Invenio product manager is appointed by CERN. Architects, coordinators and
-maintainers are appointed by the Invenio product manager in collaboration with
-existing architects and coordinators.
-
-Maintainers are appointed by the architects (e.g. a new Invenio module) or
-coordinators (e.g. a new special interest group).
-
-In general, appointments are made in an informal way, and usually anyone
-volunteering that have been showing commitment to the project will get
-appointed. Any member can volunteer or suggest other members for roles.
-
-**Revoking of appointed roles**
-
-The product manager may revoke appointed roles of a member for reasons such as
-(but not limitied to):
-
-- lack of activity
-- violations of the code of conduct
-- repeated infringements of the contribution, style or maintainer guides.
-
-The product manager must give a warning to the member to allow them to correct
-their behavior except in severe cases. Revoking roles should be a last measure,
-and only serve the purpose to ensure that Invenio has a healthy community and
-collaboration based on our :ref:`code-of-conduct`.
-
-Working/Interest groups
------------------------
-Working/interest groups may be set up by the product manager on request of any
-group of members who wish to address a particular area of Invenio (say MARC21
-support or research data management). Working/interest groups help coordinate
-the overall vision, strategy and architecture of a specific area of Invenio.
-Each working/interest group must have chair that reports to the product
-manager.
+Please see the full governance on https://inveniosoftware.org/governance/

docs/getting-started/history.rst docs/community/history.rst

@@ -80,3 +80,24 @@ deal with very large research datasets.
 Thus, in late 2015 we were being slowed so much down by our past legacy that we
 saw no other way that starting over from scratch if we were to deal with the
 next 20 years of challenges.
+
+Mailing lists
+-------------
+We have discontinued the use of mailing lists, but for historical reasons you
+can still find them here:
+
+- ``[email protected]``: Originally used for announcing new
+  Invenio releases and other major news concerning the project.
+  `archive <https://groups.cern.ch/group/project-invenio-announce/Lists/Archive/100.aspx>`_
+- ``[email protected]``: Originally used for discussion among
+  users and administrators of Invenio instances.
+  `old general archive <https://groups.cern.ch/group/project-invenio-general/Lists/Archive/100.aspx>`_,
+  `very old general archive <https://groups.cern.ch/group/project-cdsware-users/Lists/Archive/100.aspx>`_
+- ``[email protected]``: Originally used for discussion among
+  Invenio developers.
+  `old devel archive <https://groups.cern.ch/group/project-invenio-devel/Lists/Archive/100.aspx>`_,
+  `very old devel archive <https://groups.cern.ch/group/project-cdsware-developers/Lists/Archive/100.aspx>`_
+
+Note that all the mailing lists are also archived (as of the 20th of
+July, 2011) on `The Mail Archive <http://www.mail-archive.com/>`_.
+

docs/community/index.rst

@@ -21,3 +21,4 @@ are here for the interested.
     governance
     code-of-conduct
     license
+    history

docs/conf.py

@@ -52,7 +52,7 @@
 
 # General information about the project.
 project = u'Invenio'
-copyright = u'2015-2019, CERN'
+copyright = u'2015-2020, CERN'
 author = u'CERN'
 
 # The version info for the project you're documenting, acts as replacement for

docs/documentation/bundles/alpha.rst

@@ -0,0 +1,57 @@
+Invenio modules (alpha)
+-----------------------
+.. note::
+
+    These modules are in alpha. The modules are being used in production
+    systems but are most likely subject to changes and are missing
+    documentation.
+
+In addition to above bundles, we have a number of other individual modules
+which are all being used in production systems, but which are likely subject
+to change prior to final release and in most cases are missing documentation.
+
+- `invenio-accounts-rest <https://invenio-accounts-rest.readthedocs.io>`_
+    - REST APIs for account management.
+- `invenio-charts-js <https://invenio-charts-js.readthedocs.io>`_
+    - AngularJS application for producing charts.
+- `invenio-csl-js <https://invenio-csl-js.readthedocs.io>`_
+    - AngularJS application for rendering citation strings via the records
+      REST API and the CSL REST API.
+- `invenio-csl-rest <https://invenio-csl-rest.readthedocs.io>`_
+    - REST API for retrieving Citation Style Language (CSL) style files.
+- `invenio-github <https://invenio-github.readthedocs.io>`_
+    - GitHub integration with automatic archiving of new releases in Invenio.
+- `invenio-openaire <https://invenio-openaire.readthedocs.io>`_
+    - Integration with OpenAIRE, including support for harvesting Open Funder
+      Regsitry and the OpenAIRE grants database, as well as REST APIs for
+      funders and grants.
+- `invenio-opendefinition <https://invenio-opendefinition.readthedocs.io>`_
+    - REST API for licenses from OpenDefinition and SPDX.
+- `invenio-pages <https://invenio-pages.readthedocs.io>`_
+    - Static pages module for Invenio.
+- `invenio-pidrelations <https://invenio-pidrelations.readthedocs.io>`_
+    - Persistent identifier relations management to support e.g. DOI
+      versioning.
+- `invenio-previewer-ispy <https://invenio-previewer-ispy.readthedocs.io>`_
+    - ISPY previewer.
+- `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-s3 <https://invenio-s3.readthedocs.io>`_
+    - Support for the S3 storage protocol in Invenio.
+- `invenio-saml <https://invenio-saml.readthedocs.io>`_
+    - SAML support for Invenio.
+- `invenio-sequencegenerator <https://invenio-sequencegenerator.readthedocs.io>`_
+    - Module for minting and tracking multiple sequences for e.g. report
+      numbers, journals etc.
+- `invenio-sse <https://invenio-sse.readthedocs.io>`_
+    - Server-Sent Events (SSE) integration in Invenio.
+- `invenio-webhooks <https://invenio-webhooks.readthedocs.io>`_
+    - REST API for receiving and processing webhook calls from third-party
+      services.
+- `invenio-xrootd <https://invenio-xrootd.readthedocs.io>`_
+    - Support for the storage protocol XRootD in Invenio.
+- `react-searchkit <https://invenio-react-searchkit.readthedocs.io>`_
+    - Modular React library for implementing search interfaces on top of
+      Invenio, Elasticsearch or other search APIs. Replacement for
+      Invenio-Search-JS.

docs/documentation/bundles/auth.rst

@@ -0,0 +1,29 @@
+Auth bundle
+-----------
+The auth bundle contains all modules related to account and access management,
+user profiles, session management and OAuth (provider and client)
+
+Included modules:
+
+- `invenio-access <https://invenio-access.readthedocs.io>`_
+    - Role Based Access Control (RBAC) with object level permissions.
+- `invenio-accounts <https://invenio-accounts.readthedocs.io>`_
+    - User/role management, registration, password recovery, email
+      verification, session theft protection, strong cryptographic hashing of
+      passwords, hash migration, session activity tracking and CSRF protection
+      of REST API via JSON Web Tokens.
+- `invenio-oauth2server <https://invenio-oauth2server.readthedocs.io>`_
+    - OAuth 2.0 Provider for REST API authentication via access tokens.
+- `invenio-oauthclient <https://invenio-oauthclient.readthedocs.io>`_
+    - User identity management and support for login via ORCID, GitHub, Google
+      or other OAuth providers.
+- `invenio-userprofiles <https://invenio-userprofiles.readthedocs.io>`_
+    - User profiles for integration into registration forms.
+
+The modules relies heavily on a suite of open source community projects:
+
+- `flask-security <https://pythonhosted.org/Flask-Security/>`_
+- `flask-login <https://flask-login.readthedocs.io/>`_
+- `flask-principal <https://pythonhosted.org/Flask-Principal/>`_
+- `flask-oauthlib <https://flask-oauthlib.readthedocs.io/>`_
+- `passlib <https://passlib.readthedocs.io/en/stable/>`_

docs/documentation/bundles/base.rst

@@ -0,0 +1,48 @@
+Base bundle
+-----------
+The base bundle contains all modules related to the generic web application.
+This includes the Flask/Celery application factories, configuration management,
+I18N, logging, database management, assets/theme management, mail handling and
+administration interface.
+
+Included modules:
+
+- `invenio-admin <https://invenio-admin.readthedocs.io>`_
+    - Administration interface for Invenio based on Flask-Admin.
+- `invenio-app <https://invenio-app.readthedocs.io>`_
+    - Flask, WSGI, Celery and CLI applications for Invenio including
+      security-related headers and rate limiting.
+- `invenio-assets <https://invenio-assets.readthedocs.io>`_
+    - Static files management and Webpack integration for Invenio.
+- `invenio-base <https://invenio-base.readthedocs.io>`_
+    - Flask application factories implementing the application loading patterns
+      with entry points in Invenio.
+- `invenio-cache <https://invenio-cache.readthedocs.io>`_
+    - Caching module for Invenio, supporting Redis and Memcached as backends.
+- `invenio-celery <https://invenio-celery.readthedocs.io>`_
+    - Task discovery and default configuration of Celery for Invenio.
+- `invenio-config <https://invenio-config.readthedocs.io>`_
+    - Configuration loading pattern responsible for loading configuration from
+      Python modules, instance folder and environment variables.
+- `invenio-db <https://invenio-db.readthedocs.io>`_
+    - Database connection management for Invenio.
+- `invenio-formatter <https://invenio-formatter.readthedocs.io>`_
+    - Jinja template engine utilities for Invenio.
+- `invenio-i18n <https://invenio-i18n.readthedocs.io>`_
+    - I18N utilities like user locale detection, message catalog merging and
+      views for language change.
+- `invenio-logging <https://invenio-logging.readthedocs.io>`_
+    - Configuration of logging to both console, files and log aggregation
+      engines like `sentry.io <https://sentry.io/>`_
+- `invenio-mail <https://invenio-mail.readthedocs.io>`_
+    - Mail sending for Invenio using Flask-Mail.
+- `invenio-rest <https://invenio-rest.readthedocs.io>`_
+    - REST API utilities including Cross Origin Resource Sharing (CORS) and
+      Content Negotiation versioning support.
+- `invenio-theme <https://invenio-theme.readthedocs.io>`_
+    - Jinja templates implementing a basic theme for Invenio as well as menus
+      and breadcrumbs support.
+- `docker-invenio <https://docker-invenio.readthedocs.io>`_
+    - Docker base images based on CentOS 7 for Invenio.
+- `pytest-invenio <https://pytest-invenio.readthedocs.io>`_
+    - Testing utilities for Invenio modules and applications.