Permalink
Branch: master
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
70 lines (56 sloc) 9.01 KB

Publication Flow

:doc:`documents` (and their associated files) are all publishable documents (except :ref:`data-access-requests`). Being a publishable document means that there can be different revisions of the document before being published.

The publication flow refers to the work flow from a draft document to its publication. The following diagram represent the life cycle of a document with its :ref:`revision-status` and :ref:`transitions`:

images/mica-publication-flow.png

Revision Status

The publishable document goes through several states allowing to separate user privileges: some users will be responsible for the content edition only, while other users will be responsible for the reviewing and the publication of the document.

A draft document can be changed/edited as many times as necessary. When the edition work is done, the document is staged for being reviewed. The state of the document that is reviewed is the one that will be published. Once the review and the publication is done, the document is ready again for edition. When a document is to be removed, it is first marked as being deleted (without affecting the publication) before being permanently removed.

The revision status is an enumeration of named states:

Status Description Editable Publishable Deletable From Status To Status
Draft
The document is in the editable state.

This state requires lesser privileges: the document cannot be
published nor deleted, it can only be staged for these operations.
images/check.png images/error.png images/error.png
  • Under Review
  • Deleted
  • Under Review
  • Deleted
Under Review
Staged for reviewing, allowing user with higher privileges to
approve and perform publication. The document is not editable and
it can be published.

Once published it automatically goes back to the Draft status. If
the changes are not approved, the status can be switch to Draft
without affecting the publication.
images/error.png images/check.png images/error.png
  • Draft
  • Draft
  • Deleted
Deleted
Staged for permanent deletion. The document is not editable, nor
publishable. Being published does not prevent a document from
going into the Deleted state: the un-publication will be effective
when the deletion is permanent. Note also that the document can be
un-published at any time.
images/error.png images/error.png images/check.png
  • Draft
  • Under Review
  • Draft

Transitions

The transitions between the different revision status are the following:

Transition Description Permission From Status To Status
To Under Review Once changes have be saved, the document is ready to be reviewed.
  • Edit
  • Review
  • Draft
  • Under Review
To Draft
If reviewed changes or the deletion are rejected, the document
can return to the draft state for edition.
  • Edit
  • Review
  • Under Review
  • Deleted
  • Draft
Publish
When changes have been reviewed and approved, the document can be
published: the current state of the document is persisted in the
publication repository.
  • Review
  • Under Review
  • Draft
To Deleted Approval for document deletion is requested.
  • Edit
  • Review
  • Draft
  • Deleted
Delete
Deletion is approved and effective. If the document was published,
it is removed from the publication repository.
  • Review
  • Deleted