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: move 'datatypes' content to new topic section #4449

Closed
4 tasks
ramirezfranciscof opened this issue Oct 16, 2020 · 4 comments · Fixed by #4469
Closed
4 tasks

Docs: move 'datatypes' content to new topic section #4449

ramirezfranciscof opened this issue Oct 16, 2020 · 4 comments · Fixed by #4469
Assignees

Comments

@ramirezfranciscof
Copy link
Member

This is a structure that was left over from the old documentation and needs to be removed, but first we need to check if all the content has been re-assigned in the new documentation. The files considered are:

Proposition:

It is not clear to me what to do with this, maybe we should create a "Topics/data" section for this?

@mbercx
Copy link
Member

mbercx commented Oct 18, 2020

It is not clear to me what to do with this, maybe we should create a "Topics/data" section for this?

👍 I'd be in favour of having a "Topics/Data Types" section, which explains the purpose/content of each data type and maybe some basic usage. Let's see if the others agree, if so I'm happy to work on this.

@sphuber
Copy link
Contributor

sphuber commented Oct 19, 2020

Let's create a new topic called Data types and move the existing content there. Propose to start with the data types that are generic and will stay in aiida-core, followed by a section for the materials science specific ones that will be moved out of the package at some point. This will make the move easier as well.

@sphuber sphuber changed the title Docs: remove old content in 'datatypes/' Docs: move 'datatypes' content to new topic section Oct 19, 2020
@ramirezfranciscof
Copy link
Member Author

To whoever takes this: please delete the old files in the PR with the new section.

@mbercx mbercx self-assigned this Oct 19, 2020
@mbercx
Copy link
Member

mbercx commented Oct 19, 2020

While working on this, I noticed that the functionality.rst file contains mainly information on how to export the data types. Some of this information is data type specific, so perhaps this can be put as usage examples in the topics section, but it starts with some more general content on exporting data that may be more at home in the "How to - share data" section (see #3998).

I'll move it into the "Topics - Data Types" section for now as I rework it, but if we don't move it we should at least link to it from the "How to - share data" section.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants