🔀 MERGE: Release v2.0.0b1 #5426
Conversation
|
@chrisjsewell is this ready for review? |
Categorized Pull RequestsStorage and migrationskey:
other:
API
Engine/Schedulers/Transport
scheduler/transport:
Entry points
CLI
REST API
Developers
typing:
other dependency:
📚 DOCS
Superfluous
Uncategorized
|
There was a problem hiding this comment.
Thanks @chrisjsewell , really useful changelog. There are just a few small comments and suggestions. What was the plan for the version bump. So far, we have always been combining the version bump with the addition of the changelog as the release commit. I think it makes sense to keep that. Do you want to rebase this to have one commit with all the last documentation and source code changes, and then a final commit with the changelog itself and the version bump?
| # imports required for docs/source/reference/api/public.rst | ||
| from aiida import ( # pylint: disable=unused-import | ||
| cmdline, | ||
| common, | ||
| engine, | ||
| manage, | ||
| orm, | ||
| parsers, | ||
| plugins, | ||
| schedulers, | ||
| tools, | ||
| transports, | ||
| ) |
There was a problem hiding this comment.
Why do they have to be imported in this particular file?
There was a problem hiding this comment.
This is required in docs/source/reference/api/public.rst, by the autoattribute directive.
What it actually does, is calls, e.g. getattr(aiida, 'tools'), which gives an AttributeError, if you haven't actually already loaded the module.
| :::{important} | ||
| The migration of large storage repositories is a potentially time-consuming process. | ||
| It may take several hours to complete, depending on the size of the repository. | ||
| It is also advisable to make a full manual backup of any AiiDA setup with important data: see [the installation management section](docs/source/howto/installation.rst) for more information. |
There was a problem hiding this comment.
Why not refer directly to the backup section?
There was a problem hiding this comment.
So the idea here, is that the Markdown links will work, when you are viewing the "raw" changelog file.
i.e. if you go to https://github.com/chrisjsewell/aiida_core/blob/v2-changelog/CHANGELOG.md
You can click on the link, and it will actually take you to that documentation source page.
That would not work, if you simply use e.g. {ref}`the installation management section <how-to:installation:backup>`
In MyST you can actually link to heading anchors: https://myst-parser.readthedocs.io/en/latest/syntax/optional.html#auto-generated-header-anchors,
BUT that only works if the "target" page is also Markdown,
e.g. [the installation management section](docs/source/howto/installation.md#backing-up-your-installation)
|
|
||
| #### Dict usage | ||
|
|
||
| The {class}`~aiida.orm.Dict` class has been updated to support more native `dict` behaviour: |
There was a problem hiding this comment.
Unless you have added this elsewhere, would be good to add that the explicit dict keyword in the constructor is no longer required.
yep sounds good |
chrisjsewell
force-pushed
the
v2-changelog
branch
from
dc7f2e5
to
b2b62d9
Compare
chrisjsewell
changed the title
|
Cheers, for me this would be good to go, I just think we should merge the PRs I opened this weekend that fix bugs in the CLI that were introduced in The other PRs are features or non-critical fixes so they can be done after the release. |
chrisjsewell
force-pushed
the
v2-changelog
branch
from
b2b62d9
to
b808643
Compare
chrisjsewell
force-pushed
the
v2-changelog
branch
2 times, most recently
from
82e153b
to
c1854e5
Compare
chrisjsewell
force-pushed
the
v2-changelog
branch
from
c1854e5
to
8b2f66d
Compare
https://aiida--5426.org.readthedocs.build/projects/aiida-core/en/5426/reference/_changelog.html
also: https://aiida--5426.org.readthedocs.build/projects/aiida-core/en/5426/howto/archive_profile.html