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.

Sign up for GitHub

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

Jump to bottom

Migrate v1.0.0 backward incompatible changes page to Sphinx Docs for release #2482

Closed
3 tasks done
ConradJohnston opened this issue Feb 15, 2019 · 1 comment · Fixed by #3109
Closed
3 tasks done

Migrate v1.0.0 backward incompatible changes page to Sphinx Docs for release #2482

ConradJohnston opened this issue Feb 15, 2019 · 1 comment · Fixed by #3109
Assignees
@sphuber
Labels
priority/critical-blocking must be resolved before next release topic/documentation
Projects
Release 1.0.0
Milestone
v1.0.0

Comments

@ConradJohnston
Copy link
Contributor

ConradJohnston commented Feb 15, 2019 •
edited by sphuber
Loading

Currently, the docs on backward-incompatible changes are being composed on this Wiki page .

Before v1.0.0b is released, the following should be done:

  • Finalise content of the wiki page
  • Convert the markdown format content to restructured text.
    One can use pandoc for this: $ pandoc wikitext.md -o sphinxtext.rst
  • Replace the placeholder in the docs (docs/source/install/updating_installation) with this finalised text
@ConradJohnston ConradJohnston added the priority/critical-blocking must be resolved before next release label Feb 15, 2019
@ConradJohnston ConradJohnston added this to To do in v1.0.0b1 via automation Feb 15, 2019
ConradJohnston added a commit to ConradJohnston/aiida_core that referenced this issue Feb 15, 2019
@ConradJohnston
DOCS: Create placeholder for v1.0 breaking changes
fd38042 
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.
@ConradJohnston ConradJohnston mentioned this issue Feb 15, 2019
Merged
ConradJohnston added a commit to ConradJohnston/aiida_core that referenced this issue Feb 15, 2019
@ConradJohnston
DOCS: Create placeholder for v1.0 breaking changes
2586f0c 
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.
ConradJohnston added a commit to ConradJohnston/aiida_core that referenced this issue Feb 15, 2019
@ConradJohnston
DOCS: Create placeholder for v1.0 breaking changes
8c049ef 
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.
@giovannipizzi
Copy link
Member

I would do this for 1.0.0 and keep in the wiki for the beta lifetime

@giovannipizzi giovannipizzi removed this from To do in v1.0.0b1 Feb 22, 2019
@giovannipizzi giovannipizzi added this to the v1.0.0 milestone Feb 22, 2019
@giovannipizzi giovannipizzi mentioned this issue Feb 22, 2019
Closed
@sphuber sphuber added this to To do in Release 1.0.0 via automation Apr 3, 2019
@sphuber sphuber moved this from To do to To do (priority) in Release 1.0.0 Jul 1, 2019
@sphuber sphuber self-assigned this Jul 1, 2019
@sphuber sphuber moved this from To do (priority) to In progress in Release 1.0.0 Jul 1, 2019
@sphuber sphuber mentioned this issue Jul 1, 2019
Merged
Release 1.0.0 automation moved this from In progress to Done Jul 1, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@sphuber sphuber

Labels
priority/critical-blocking must be resolved before next release topic/documentation
Projects
No open projects
Release 1.0.0
  
Done
Milestone
v1.0.0
Development

Successfully merging a pull request may close this issue.

Docs: refresh update instructions and add backward incompatible changes sphuber/aiida-core
3 participants
@sphuber @giovannipizzi @ConradJohnston