Wednesday, September 20, 2023
doc@conference.yunohost.org
September
Mon Tue Wed Thu Fri Sat Sun
        1
2
3
4
5
6
7 8
9 10
11
12
13 14
15
16 17
18
19
20
21
22
23 24
25
26
27
28
29 30
 
             

[13:55:54] <Salamandar> Ah yeah by the way you talked about using something like Hugo for documentation ?
[13:56:01] <Salamandar> what’s your issue with grav ?
[13:58:11] <Aleks (he/him/il/lui)> Docusaurus
[13:58:56] <Aleks (he/him/il/lui)> Not a huge deal but Grav is kind of bloated with too many addons for basic features and we have like random weird SQL errors due to dynamic rendering when we could just have a static website
[13:59:07] <Aleks (he/him/il/lui)> and docusaurus looks much more kiss and clean i guess
[13:59:27] <Aleks (he/him/il/lui)> but as said not really a huge deal / top priority, that would probably involve refactoring all the pages structure /again/
[14:00:18] <Salamandar> Yeah alright, I see
[14:00:23] <Salamandar> i don’t know docusaurus
[14:00:54] <Salamandar> oh but wait
[14:01:38] <Salamandar> yes I very much know it without knowing its name
[14:01:39] <Salamandar> very pretty
[14:01:46] <Salamandar> ++ !!
[14:02:39] <Salamandar> it loks slick and modern
[14:03:12] <Salamandar> Would it be something I can help on ? Maybe do a PoC ?
[14:27:36] <Aleks (he/him/il/lui)> haha yes if that motivates you sure
[14:27:49] <Aleks (he/him/il/lui)> (ping tituspijean with whom we were discussing this during the camp ^)
[15:06:48] <tituspijean> SalamandarAleks (he/him/il/lui) Yup indeed, the advantage of Grav is its admin panel that helps you configure it and edit pages... but we don't use it at all, so what's the point of relying on PHP to generate the pages while we could build a static website that relies on JS for some magic ;)
[15:08:40] <tituspijean> You are very welcome to prototype something, I thinking the best PoC would be to transcribe the install page, that is definitely the most complex page of the documentation. The app catalog is being reworked by Aleks, so no worries here. Other things to handle: i18n and search.
[15:20:43] <Salamandar> > <@titus:pijean.ovh> SalamandarAleks (he/him/il/lui) Yup indeed, the advantage of Grav is its admin panel that helps you configure it and edit pages... but we don't use it at all, so what's the point of relying on PHP to generate the pages while we could build a static website that relies on JS for some magic ;)

Looks like it's not so static ? doc speaks about node.js
[15:21:11] <tituspijean> For the generation I guess ?
[15:21:25] <Aleks (he/him/il/lui)> the other complex page is the install page where you can choose RPi / VM / VPS etc, it's a soup of twig code etc
[15:21:37] <Salamandar> ah yes 😄
[15:21:38] <Aleks (he/him/il/lui)> but we could also just rewrite it using some "static" JS instead of SSR idk
[15:21:53] <Aleks (he/him/il/lui)> i mean if it's "just that" we can find a trick
[15:22:16] <Salamandar> > <@titus:pijean.ovh> For the generation I guess ?

yeah probably ^^
[15:22:54] <Salamandar> So no one started working on it ? no duplicates ? 😄
[15:24:01] <Aleks (he/him/il/lui)> nope
[15:24:28] <Salamandar> ok !
[15:24:28] <Aleks (he/him/il/lui)> wut xD
[15:24:49] <tituspijean> Selfhoster maybe? From the camp? Not sure. :)
[15:25:12] <Aleks (he/him/il/lui)> he sort of tried working on the landpage then got desperate because of some obscure reason related to grav and docker
[15:29:17] <Salamandar> Whow… Docusaurus loads the pages when we hover the button on the side bar
[15:29:28] <Salamandar> that is some next-level UX optimization
[16:40:15] <Salamandar> Well HTML tables are horrible, but
[16:40:27] <Salamandar> this is in docusaurus
[16:40:27] <Salamandar> https://aria.im/_matrix/media/v1/download/matrix.org/DumyFHCnxffchgmgVLLuWjLh
[16:40:55] <Salamandar> also mdx/jsx is reaaaaaaaaaally weird… considering i don't know web at all too 😄
[17:24:13] <Salamandar> OK I get what you said about the install page 😄
[17:24:23] <Salamandar> I opened the file and said "wuuuuuuuuuuut"
[17:27:02] <Salamandar> I think the best would be sub pages, like https://www.home-assistant.io/installation/
[17:48:44] <Aleks (he/him/il/lui)> not sure what you mean but subpages, we had one page per "setup type" in the past and it was hell to maintain because many parts are redundant between setup types, and it's better to have a single page with advanced logic
[17:49:04] <Aleks (he/him/il/lui)> we could easily handle this using like `data-setup-type="foo bar"` attributes and just a few lines of JS
[17:49:15] <Aleks (he/him/il/lui)> not really worried about it, it will just be boring to recode stuff
[17:51:37] <Salamandar> > <@Alekswag:matrix.org> not sure what you mean but subpages, we had one page per "setup type" in the past and it was hell to maintain because many parts are redundant between setup types, and it's better to have a single page with advanced logic

Well first, the initial setup part is mostly common, and it should just be split into its own page
[17:52:20] <Aleks (he/him/il/lui)> yeah but then the postinstall page is mostly common too etc
[17:52:42] <Aleks (he/him/il/lui)> and "ssh-ing" into the server too, but sometime you need to find the local IP, but not on all setup, etc
[17:53:07] <Aleks (he/him/il/lui)> i mean every section is relevant for 2 or 3 kinds of setup but you want to avoid maintaining like 10 differents pages lie in the past
[17:53:26] <Aleks (he/him/il/lui)> and in terms of UX it's better to not have to constantly switch between 10 differents pages along the install
[17:53:40] <Salamandar> > and "ssh-ing" into the server too, but sometime you need to find the local IP, but not on all setup, etc

That can be handled by a "On this setup, please remind the IP address is the local one" on the specific page
[17:58:02] <Salamandar> > <@Alekswag:matrix.org> and in terms of UX it's better to not have to constantly switch between 10 differents pages along the install

Yeah, agreed, but splitting this install page in 2 pages (installation and post install) makes a lot of sense to me
[17:58:33] <Salamandar> Also considering you have to go to "finding your ip", "forward ports" that is irrelevant to non-local installs
[17:59:12] <Salamandar> In docusaurus you can configure `pagination_next`, so we can select which page links to what after installation
[17:59:47] <Salamandar> Also the pre-installed images page should be merged with the install page IMHO
[18:00:48] <Aleks (he/him/il/lui)> well the install page is supposed to display the relevant image for the setup you chose
[18:00:48] <Salamandar> for example on https://www.home-assistant.io/installation/raspberrypi#install-home-assistant-operating-system
[18:01:02] <Salamandar> you have multiple "onboarding" buttons that goes to the post-install page
[18:01:10] <Salamandar> so the install page only has "hardware" relevant information
[18:01:33] <Salamandar> same for https://www.home-assistant.io/installation/windows
[18:01:42] <Salamandar> > <@Alekswag:matrix.org> well the install page is supposed to display the relevant image for the setup you chose

Yes, agreed. So is it duplicate ?
[18:02:17] <Aleks (he/him/il/lui)> i'm not sure what you mean, my point is that it's already "sort of merged"
[18:02:26] <Aleks (he/him/il/lui)> but people still somehow want a page with all the images available
[18:02:45] <Salamandar> ah yes ok 🙂
[18:02:50] <Aleks (he/him/il/lui)> but on the other hand if the person select a specific hardware there's no point displaying all the images available except for the ones relevant for the setup
[18:03:09] <Aleks (he/him/il/lui)> ie on https://yunohost.org/fr/install/hardware:rpi34 you get the image for RPi
[18:08:45] <Salamandar> > <@Alekswag:matrix.org> but on the other hand if the person select a specific hardware there's no point displaying all the images available except for the ones relevant for the setup

Oh yeah, I fully agree
[20:17:25] <Yunohost Git/Infra notifications> [doc] @Thatoo opened [pull request #2344](https://github.com/YunoHost/doc/pull/2344): Update apps_wishlist.md
[20:31:47] <Yunohost Git/Infra notifications> [doc] @orhtej2 opened [pull request #2345](https://github.com/YunoHost/doc/pull/2345): Added skeleton SnappyMail docs.
[20:49:50] <Salamandar> OK maybe https://docusaurus.io/docs/markdown-features/tabs#syncing-tab-choices would help Aleks (he/him/il/lui)
[21:33:08] <Salamandar> almost there… https://salamandar.github.io/yunodocusaurus/
[21:54:36] <Salamandar> https://salamandar.github.io/yunodocusaurus/docs/installation/

[21:55:02] <Salamandar> (ok the next pages are just empty for now :|)
[21:55:57] <Salamandar> Clearly Docusaurus is made for web devs ^^''
[22:03:28] <Salamandar> I'm especially happy how https://salamandar.github.io/yunodocusaurus/docs/administration-guide/providers/isps looks with tabs
[22:10:01] <tituspijean> *so nice*
[22:15:18] <Yunohost Git/Infra notifications> [doc] @orhtej2 opened [pull request #2346](https://github.com/YunoHost/doc/pull/2346): Added docs for umami
[22:23:28] <lapineige> Nice work !