Skip to content

Commit

Permalink
DOCS: Create placeholder for v1.0 breaking changes
Browse files Browse the repository at this point in the history
Resolves #2320

- Created a placeholder section in install/updating_installation
where the finalised prose describing all of the important behaviour changing and
backwards-incompatible change should be placed before the v1.0.0b release.
The content of this section is being drafted on the wiki at:
https://github.com/aiidateam/aiida_core/wiki/Backward-incompatible-changes-in-1.0.0
Before the beta release, the finalised content from the wiki page should be converted using
`pandoc` and then pasted in this section.

- Moved the section about converting workchains to the wiki. This section should be
included in the larger v1.0 changes text so that we don't have to maintain two seperate
versions of it.

Refer also to issue #2482.
  • Loading branch information
ConradJohnston committed Feb 15, 2019
1 parent 08e422c commit 2586f0c
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions docs/source/install/updating_installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -86,3 +86,13 @@ To find the update instructions for older versions of AiiDA follow the following
SQLAlchemy backend. In case you were using SQLAlchemy before the introduction
of Alembic, you may experience problems during your first migration. If it is
the case, please see :ref:`this section <first_alembic_migration>`.



.. _backward_incompatible_changes_beta_release:

Backward incompatible changes in ``v1.0.0``
===========================================

The list of all backward-incompatible changes between the 0.x series and AiiDA 1.0 is
maintained `here <https://github.com/aiidateam/aiida_core/wiki/Backward-incompatible-changes-in-1.0.0>`_.

0 comments on commit 2586f0c

Please sign in to comment.