Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DOCS: Create placeholder for v1.0 breaking changes #2483

Merged

Conversation

ConradJohnston
Copy link
Contributor

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.

@coveralls
Copy link

coveralls commented Feb 15, 2019

Coverage Status

Coverage decreased (-0.03%) to 69.985% when pulling 6ede385 on ConradJohnston:provenance_redesign into dace59e on aiidateam:provenance_redesign.


.. note::

Insert the finalised content form the `Wiki <https://github.com/aiidateam/aiida_core/wiki/Backward-incompatible-changes-in-1.0.0>`_ here.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would add a message more targeted for users, like "The list of all backward-incompatible changes between the 0.x series and AiiDA 1.0 is maintained here."

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, no worries. Done.

Resolves aiidateam#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 aiidateam#2482.
@sphuber sphuber merged commit 1ed73d8 into aiidateam:provenance_redesign Feb 16, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants