improve contribution

Author: mjeammet

submissions/yunohosters/README.md

@@ -1,16 +1,19 @@
 # 🏆 Final Submission for Yunohosters
 
 ## Project
-Docs for Yunohost
+Docs for Yunohost.
 
 ## Project Description
-Package Docs on YunoHost
 
+YunoHost is an Debian-based operating system aiming at simplifying server administration and therefore democratize self-hosting while making sure it stays reliable, secure, ethical and lightweight. It is a copyleft libre software project maintained exclusively by volunteers, who have been packaging in a 600+ apps store in the course of 13 years. 
 
-## Contributors
+Packaging Docs on YunoHost
+
+[More on Yunohost](https://doc.yunohost.org/admin/what_is_yunohost/)
 
-<a href="https://github.com/Maeva-Calmettes">@Maeva</a>, <a href="https://github.com/DDATAA">@DDATAA</a>, <a href="https://github.com/fflorent">@fflorent</a>, <a href="https://github.com/mjeammet">@mjeammet</a>, <a href="https://github.com/rouja">@rouja</a>
+## Contributors
 
+<a href="https://github.com/DDATAA">@DDATAA</a>, <a href="https://github.com/fflorent">@fflorent</a>, <a href="https://github.com/mjeammet">@mjeammet</a>, <a href="https://github.com/rouja">@rouja</a>, <a href="https://github.com/Maeva-Calmettes">@Maeva</a>
 
 ## Code base
 https://github.com/YunoHost-Apps/docs_ynh/
@@ -19,32 +22,38 @@ https://github.com/YunoHost-Apps/docs_ynh/
 We'll add a video tomorrow. 
 
 ## Key Achievements
-(Highlight the main features or breakthroughs)
+
+Install script done. You can now self-host Docs in a few click, without having to trouble yourself with sys admin complexity.
+Fixed Garage's Yunohost package. Garage is a S3 storage alternative, that might be a good replacement of MiniO after recent changes of policy.
 
 ## Challenges Overcome
 
-How to install Docs without docker
+**How to install Docs without docker ?**
 
 Docs is usually installed using docker but Yunohost is about rebuilding from sources. 
 
-Which version of Python3.12
+***Which version of Python3.12 ?**
+
+Docs runs on Python 3.12, a relatively recent version of Python which is still not shipped in recent Debian versions. Thus, many Yunohost installs won't have native Python 3.12. This caused us a few hesistations. Should we add a ppa to an additional source or recompile Python 3.12 ? In the end, we decided to patch Docs's code (which is very easily done with Yunohost system) to lower requirements to Python 3.11, hoping that no breaking changes happened between 3.11 and 3.12. 
 
-Yunohost's default version of Python is 3.11. Docs expects 3.12. 
+**Authentication**
 
-Auth
+Docs expects a OIDC and Yunohost's auth system is currently based on LDAP. Waiting for future Yunohost version, which will include native-OIDC auth, we used Dex in the meantime. 
 
-Docs expects a OIDC and Yunohost's auth system is based on LDAP. Waiting for future yunohost version to rely on Authelia for this kind of situations, we used Dex in the meantime. 
+**S3 storage**
 
-Which S3 ?
+With the recent change of policy from Minio, we decided to work on making our package compatible with Garage, another S3 storage solution. Garage has received some extra attention these days and the corresponding Yunohost package received an update that we helped fixing/merging.
 
-With the recent change of policy from Minio, we decided to switch to Garage, another S3 which package is already partially functioning in Yunohost.
+**Websockets**
 
-Websockets
+@rouja used a few sysadmin magic tricks to enable real-time collaboration.
 
 ## Impact
-Self-hosting and the creation of community is a big stake of all open-source apps - including La Suite. By allowing smaller structures and individuals to self-host, Yunohost might be a good way to build community around La Suite's apps and turn this public code into small but real public uses.
+Self-hosting and the creation of community is a big stake of all open-source apps - including for La Suite. By allowing smaller structures and individuals to self-host, Yunohost might be a good way to build community around La Suite's apps and turn this public code into small but real uses.
 
 ## Next Steps
 - Maintenance of the package overtime
 - Change OIDC to work with Authelia
+- Watch compatibility between Python3.12 and Python3.11
+- Finish compatibility with Garage ?
 - Address future issues, both on Github and the forum