Docs reorganization - step 2 (installation section)#2330
Conversation
* add OS instructions using foldable sections * quicksetup now actually contains all information required
sphuber
left a comment
sphuber
left a comment
There was a problem hiding this comment.
Great work @ltalirz , I really like the new structure. All good as far as I am concerned. I have just a few minor comments/typos. I realize that a few comments are not directly on things you changed, but I still think it would be good to fix them in this PR if possible
| The first thing that will be asked to you is the timezone, extremely important to get correct dates and times for your calculations. | ||
| The first thing that will be asked to you is the timezone, important to get correct dates and times for your calculations. | ||
|
|
||
| AiiDA will do its best to try and understand the local timezone (if properly configured on your machine), and will suggest a set of sensible values. |
There was a problem hiding this comment.
Is this still true? Is it still prompting for the timezone?
There was a problem hiding this comment.
Also the section below about a single default user as the daemon runner, is outdated. Each profile has its own daemon. Also, below that, there is an example output of the prompts during the setup, which is outdated. Could you update that please?
There was a problem hiding this comment.
Ok. I will simply delete this note.
@waychal Is the aiida password currently used in the REST API?
There was a problem hiding this comment.
By the way, the output of verdi setup is also outdated but interactive verdi setup anyhow needs to be fixed (#1483). After this, the output in the docs can be updated.
| .. _0.6.* SqlAlchemy: http://aiida-core.readthedocs.io/en/v0.7.0/installation.html#updating-from-0-6-0-django-to-0-7-0-sqlalchemy | ||
| .. _0.5.* Django: http://aiida-core.readthedocs.io/en/v0.7.0/installation.html#updating-from-0-5-0-to-0-6-0 | ||
| .. _0.4.* Django: http://aiida-core.readthedocs.io/en/v0.5.0/installation.html#updating-from-0-4-1-to-0-5-0 No newline at end of file | ||
| .. _0.4.* Django: http://aiida-core.readthedocs.io/en/v0.5.0/installation.html#updating-from-0-4-1-to-0-5-0 |
There was a problem hiding this comment.
Please change the first paragraph in updating for aiida developers to tell them to use verdi --version to get the current version number, instead of going into a shell.
There was a problem hiding this comment.
Will do, and I will generally merge the "for developers" section with the regular upgrade instructions.
Is the sentence " Each version increase may come with its own necessary migrations and you should only ever update the version by one at a time." actually true?
It should be fine to skip aiida versions, right?
* fix typos * update `verdi setup` docs * fix updating aiida instructions
3 participants
This is my go at reorganizing the installation section of the docs to make it more intuitive and efficient to use.
Note: I added the
provenance_redesignbranch to RTD, i.e. you'll be able to inspect the docs there (after the PR is merged).