You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This is just recording a first impression of the docs page:
Starting with "deployment" felt a bit strange to me - I would have expected "how to use" first.
On reading through the docs I think I understood the thought process behind the layout a bit better (this follows the standard pattern for a python package: install, how to use, how to develop)... however, many users of the AiiDA lab will actually never install it - they just log in.
For a python package, you typically have roughly two different types of users
some users are going to install and use the package
some users are going to want to develop the package
Both of these user types have in common that they are likely familiar with python and bash.
For the AiiDAlab, the situation is quite a bit more diverse:
some users are going to log into an existing instance and use the AIiDAlab (may not know any python or bash)
some users are going to want to develop apps
some users may want to run a docker container locally
administrators will want to deploy a multi-user instance
some admins/users will want to develop the AiiDAlab itself
It seems to me that in writing the docs we need to pay particular attention to ensure that the user group 1. is guided well and knows where to look for information.
I'll continue thinking a bit about this, input welcome.
The text was updated successfully, but these errors were encountered:
This is just recording a first impression of the docs page:
Starting with "deployment" felt a bit strange to me - I would have expected "how to use" first.
On reading through the docs I think I understood the thought process behind the layout a bit better (this follows the standard pattern for a python package: install, how to use, how to develop)... however, many users of the AiiDA lab will actually never install it - they just log in.
For a python package, you typically have roughly two different types of users
Both of these user types have in common that they are likely familiar with python and bash.
For the AiiDAlab, the situation is quite a bit more diverse:
It seems to me that in writing the docs we need to pay particular attention to ensure that the user group 1. is guided well and knows where to look for information.
I'll continue thinking a bit about this, input welcome.
The text was updated successfully, but these errors were encountered: