beauty:2018
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
beauty:2018 [2018/06/02 17:08] – [Sets of files to be examined and improved] Xavier Gonze | beauty:2018 [2018/06/03 23:11] (current) – [What should be done ?] Xavier Gonze | ||
---|---|---|---|
Line 10: | Line 10: | ||
</ | </ | ||
- | 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, " | + | ==== In practice |
- | * 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), to be ported inside the bibliography database, see https:// | + | I expect [[beauty:2018: |
- | * B. Equations might still be in "text" | + | So, please start from your develop branch |
- | * C. specific improvements of lessons of the tutorials and other files could be made, thanks | + | then issue a merge request |
- | * D. it remains to be checked that no inadvertent deterioration of the documentation has occurred. | + | |
- | * E. one might also check the correctness of links and other information | + | |
- | It is proposed that a concerted beautification operation will be done Monday 4 June - Wednesday 14 June 2018. Every contributor will be given a set of files that s/he should read and possibly correct. | + | Explicitly, issue |
- | 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). More information on the operation will be given in later sections. By the way, suggestions for improvements of the mkdocs infrastructure is also welcome, see the dedicated page. | + | |
- | The first phase will be to collect | + | - git checkout develop |
+ | - git branch beauty | ||
+ | - git checkout beauty | ||
+ | - git merge remotes/ | ||
+ | then beautify the code, then issue the proper merge request to trunk/ | ||
- | ==== Sets of files to be examined and improved | + | ==== What should |
- | - Input variables contained in abimkdocs, see the files variables_abinit.py, variables_aim.py, | + | This beautification will be focused on the documentation. Indeed, as a response to the recommendations made at the last developer |
- | - Lessons of the Tutorial | + | |
- | - Theory | + | |
- | So, the work will consists | + | * A. There are still MANY isolated bibliographical references in the descriptions of input variables or lessons of the tutorial (or other files), [[https:// |
+ | * B. Many line breaks have disappeared | ||
+ | | ||
+ | | ||
+ | * E. It remains | ||
+ | * F. One might also check the correctness of links and other information (like the coherence between the sections of output files pasted in the text, and the output files themselves, available from the links) | ||
+ | |||
+ | 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. | ||
- | 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 ==== | ||
Check first whether it exists already in the bibliographical database | Check first whether it exists already in the bibliographical database | ||
(file doc/ | (file doc/ | ||
- | Otherwise, | + | Otherwise, |
- | [[https:// | + | [[https:// |
==== I have not yet familiarized myself with abimkdocs / markdown | ==== I have not yet familiarized myself with abimkdocs / markdown | ||
Line 52: | Line 54: | ||
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.1527952134.txt.gz · Last modified: 2018/06/02 17:08 by Xavier Gonze