beauty:2018
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revisionNext revisionBoth sides next revision | ||
beauty:2018 [2018/06/02 17:27] – [What should be done ?] Xavier Gonze | beauty:2018 [2018/06/02 17:35] – [What should be done ?] Xavier Gonze | ||
---|---|---|---|
Line 12: | Line 12: | ||
==== In practice : branching/ | ==== In practice : branching/ | ||
- | I expect your contribution | + | I expect |
So, please start from your develop branch (v8.9.3 of ABINIT), branch your own " | So, please start from your develop branch (v8.9.3 of ABINIT), branch your own " | ||
then issue a merge request (using Gitlab) from " | then issue a merge request (using Gitlab) from " | ||
- | So, issue | + | Explicitly, issue |
- git checkout develop | - git checkout develop | ||
Line 22: | Line 22: | ||
- git checkout beauty | - git checkout beauty | ||
- git merge remotes/ | - git merge remotes/ | ||
- | then beautify the code, then issue the proper merge request to trunk/ | + | then beautify the code, then issue the proper merge request to trunk/ |
==== What should be done ? ==== | ==== What should be done ? ==== | ||
Line 28: | Line 28: | ||
This beautification will be focused on the documentation. Indeed, as a response to the recommendations made at the last developer workshop, in Frejus May 2017, " | This beautification will be focused on the documentation. Indeed, as a response to the recommendations made at the last developer workshop, in Frejus May 2017, " | ||
- | * A. it is likely that there are still isolated bibliographical references in the descriptions of input variables or lessons of the tutorial (or other files), | + | * A. There are still MANY isolated bibliographical references in the descriptions of input variables or lessons of the tutorial (or other files), |
- | * B. Equations might still be in " | + | * B. Equations might still be in " |
* C. specific improvements of lessons of the tutorials and other files could be made, thanks to the new mkdocs infrastructure. | * C. specific improvements of lessons of the tutorials and other files could be made, thanks to the new mkdocs infrastructure. | ||
* D. it remains to be checked that no inadvertent deterioration of the documentation has occurred. | * D. it remains to be checked that no inadvertent deterioration of the documentation has occurred. | ||
Line 35: | Line 35: | ||
| | ||
As an indication, each contributor might have to dedicate about three hours to this work (including, if not yet done, reading the mkdocs documentation and possibly training a bit with the mksite script). By the way, suggestions for improvements of the mkdocs infrastructure is also welcome, see the dedicated page. | As an indication, each contributor might have to dedicate about three hours to this work (including, if not yet done, reading the mkdocs documentation and possibly training a bit with the mksite script). By the way, suggestions for improvements of the mkdocs infrastructure is also welcome, see the dedicated page. | ||
- | ==== Sets of files to be examined and improved ==== | ||
- | - Input variables contained in abimkdocs, see the files variables_abinit.py, | ||
- | - Lessons of the Tutorial : 38 *.md files contained in doc/ | ||
- | - Theory | ||
- | |||
- | So, the work will consists in the beautification of 46 *.md files, 17 varsets and 3 remaining variables*.py files. To summarize, 66 tasks to be distributed. | ||
- | |||
- | Moreover, as the addition of new tutorial and documentation is facilitated with respect to the previous procedure, | ||
- | adding new tutorials or documentation for new executables might also be done by volunteers, or any filling of holes in the documentation. | ||
- | For example, multibinit and tdep documentation is missing (but is underway for multibinit !), the tutorial on spin/ | ||
- | could be extended, the tutorial on source_code should be rewritten from scratch... | ||
==== When an isolated bibliographical reference is found ==== | ==== When an isolated bibliographical reference is found ==== | ||
Line 64: | Line 53: | ||
Training might be another 15 minutes (e.g. starting the server with '' | Training might be another 15 minutes (e.g. starting the server with '' | ||
then trying to make some fake modifications). | then trying to make some fake modifications). | ||
+ | |||
+ | |||
+ | ==== Sets of files that will be examined and improved ==== | ||
+ | |||
+ | Most of the following files have been assigned to contributors : | ||
+ | - Input variables contained in abimkdocs, see the files variables_abinit.py, | ||
+ | - Lessons of the Tutorial : 38 *.md files contained in doc/ | ||
+ | - Theory | ||
+ | |||
+ | So, the work will consists in the beautification of 46 *.md files, 17 varsets and 3 remaining variables*.py files. To summarize, 66 tasks to be distributed. | ||
+ | |||
+ | Moreover, as the addition of new tutorial and documentation is facilitated with respect to the previous procedure, | ||
+ | adding new tutorials or documentation for new executables might also be done by volunteers, or any filling of holes in the documentation. | ||
+ | For example, multibinit and tdep documentation is missing (but is underway for multibinit !), the tutorial on spin/ | ||
+ | could be extended, the tutorial on source_code should be rewritten from scratch... |
beauty/2018.txt · Last modified: 2018/06/03 23:11 by Xavier Gonze