docs: Retrieve README #1083
docs: Retrieve README #1083
Conversation
lzianekhodja-aneo
added
the
Documentation
lzianekhodja-aneo
requested review from
lemaitre-aneo,
alouvion-aneo and
YKharouni
|
Kudos, SonarCloud Quality Gate passed!
|
There was a problem hiding this comment.
This doc should not be recreated here, and most of it already exist: https://aneoconsulting.github.io/ArmoniK/installation
The best way forward is to change links in the README to this doc, and fill the gap in https://github.com/aneoconsulting/ArmoniK/tree/main/.docs/content
|
We need to fill in the gaps and have the new documentation ready before deleting the old documentation. |
|
|
||
| In this project, we present the different steps to deploy ArmoniK scheduler in different environments. | ||
|
|
||
| # Quick install of ArmoniK |
There was a problem hiding this comment.
There was a problem hiding this comment.
Ce fichier a effectivement été supprimé mais je pense qu'il faut y mettre plus d'explication (ou plus d'explication sur ArmoniK) parce qu'en l'état, il n'est pas utilisable.
There was a problem hiding this comment.
There was a problem hiding this comment.
Ce fichier n'est à mon avis pas utile.
There was a problem hiding this comment.
Mis à jour dans la documentation (avec une version pour systemd qui simplifie grandement l'installation).
https://aneoconsulting.github.io/ArmoniK/installation/windows/wsl2-with-systemd
https://aneoconsulting.github.io/ArmoniK/installation/windows/wsl2-with-genie
There was a problem hiding this comment.
|
Let's finalize the documentation first, while updating the existing. |
Je suis désolé mais je ne vois pas où se trouve la documentation actuelle. Les quelques README éparpillés dans le repo ne sont pas maintenable pour nous mais surtout sont très difficile à utiliser par la suite rendant complexe l'intégration de nouveaux contributeurs. Il est vrai que la nouvelle documentation (en ligne) n'est pas complète mais jusqu'à preuve du contraire, pas grand monde participe à sa création. Il se trouve que Rome ne s'est pas fait en 1 jour et il en sera de même pour celle d'ArmoniK évidemment. Mais si on ne commence jamais à s'y mettre, on n'y arrivera effectivement jamais. Pour information, des issues ont été ouvertes et assignés à des membres de l'équipe mais jamais complétées. #1004 En ce qui concerne les README qui ont des liens vers nulle part, il ne faut pas hésiter à faire des pull requests pour les changer et les mettre à jour !
Sur ce point, je serai ravi d'avoir des retours. https://github.com/aneoconsulting/ArmoniK-docs-theme |
|
Je ne dis pas le contraire. Je suis complètement d'accord, la documentation n'est pas encore complète et celle d'avant faut la mettre à jour. Nous devons le faire au fur et à mesure. |
|
Please check out #1084 that revive the missing doc in the actual documentation folder, and fixes dead links. |
No description provided.