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: add info on export format to internals section #4467

Merged
merged 6 commits into from
Oct 20, 2020

Conversation

ramirezfranciscof
Copy link
Member

@ramirezfranciscof ramirezfranciscof commented Oct 19, 2020

Fix #4037
Partially addresses #4450

@ramirezfranciscof ramirezfranciscof changed the title Add info on export format to internals section Docs: add info on export format to internals section Oct 19, 2020
@giovannipizzi
Copy link
Member

Hi Francisco, can you also remove the old content from the previous source (I think it was in import_export/main.rst), either only the content you moved, or all the file, so at the end we know what we didn't migrate yet?

@ramirezfranciscof
Copy link
Member Author

ramirezfranciscof commented Oct 19, 2020

Ok; my original idea was that I could anyways wait until all associated new content was merged and then delete all files in a given "remove" issue at once (seemed better than have each one decide what part to remove of the files), but from the message in the slack and this comment I assume you prefer that each deletes the part that each copies.

PD: It seems that we are having a BIG bottleneck in the CI tests. Maybe we should discuss if there is something that can be done about this in the afternoon meeting...

@ramirezfranciscof
Copy link
Member Author

I updated all references to "export" into "AiiDA archive". There are some inconsitencies due to the references in the actual code (export_version inside the metadata.json, or the command being verdi export migrate) but I don't think there is much I can do about those.

Now should be ready to review @giovannipizzi @sphuber

Copy link
Member

@giovannipizzi giovannipizzi left a comment

Choose a reason for hiding this comment

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

Some minor suggestions.

Also, please add a redirect from the old URL describing the data storage to this new URL.

docs/source/internals/data_storage.rst Outdated Show resolved Hide resolved
docs/source/internals/data_storage.rst Outdated Show resolved Hide resolved
docs/source/internals/data_storage.rst Outdated Show resolved Hide resolved
docs/source/internals/data_storage.rst Outdated Show resolved Hide resolved
docs/source/internals/data_storage.rst Outdated Show resolved Hide resolved
docs/source/internals/data_storage.rst Outdated Show resolved Hide resolved
docs/source/internals/data_storage.rst Outdated Show resolved Hide resolved
@ramirezfranciscof
Copy link
Member Author

@giovannipizzi for now the redirection works for the full page (so import_export/main.html --> internals/data_storage.html), I have just asked if it was possible to do section redirection (import_export/main.html#export-file-format --> internals/data_storage.html#aiida-archive-format) which is the link that you originally wanted to fix.

@ramirezfranciscof
Copy link
Member Author

For which the answer is that apparently this can't be done, so I guess this is the best we can do.

@giovannipizzi giovannipizzi self-assigned this Oct 20, 2020
Copy link
Member

@giovannipizzi giovannipizzi left a comment

Choose a reason for hiding this comment

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

Thanks!

@sphuber sphuber merged commit 5e0de12 into aiidateam:develop Oct 20, 2020
@sphuber sphuber deleted the docs-4037 branch October 20, 2020 11:02
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.

Docs: Internals: Data storage (Export archive)
3 participants