2024-01-18 19:18:27 word 2024-01-18 19:18:32 o/ 2024-01-18 19:18:41 i have to leave in a bit unfortunately 2024-01-18 19:31:16 to be clear about what i've suggested in #alpine-offtopic: nothing would be moved out of the handbook. maybe a few things should get moved in. in any case, clarify the relationship between docs and wiki by linking out of docs by adding topics that the handbook does not cover. 2024-01-18 19:31:57 moreover make it clearer to people on the wiki, like, "no warranties" 2024-01-18 19:32:11 The handbook itself should mostly concentrate on things that directly involve Alpine 2024-01-18 19:32:17 if it's in the handbook, it went through a review process 2024-01-18 19:33:15 y'all hosers 2024-01-18 19:33:27 ^ valued input 2024-01-18 19:35:27 i'm not sure i'm even biased towards web documentation, but i'm sure it's what people expect. 2024-01-18 19:35:36 my bias is towards man pages 2024-01-18 19:35:45 man pages are mostly references though 2024-01-18 19:35:54 true. 2024-01-18 19:36:09 but maybe add some alpine flavor to intro 2024-01-18 19:36:13 just a thought 2024-01-18 19:36:40 They are not mutually exclusive 2024-01-18 19:39:15 my perception of things is like, i started using alpine on metal, when the conversation seemed to be mostly about vms and containers. nowadays though, it seems like there's a lot more conversation about laptops and sbcs 2024-01-18 19:39:43 I think sbcs have always been popular, even since the rpi came out 2024-01-18 19:40:20 for alpine also? 2024-01-18 19:40:27 i guess you know the download numbers 2024-01-18 19:40:35 I don't know the download numbers 2024-01-18 19:40:45 but they have been the main drivers for arches like armhf and armv7 2024-01-18 19:40:56 ah. 2024-01-18 19:43:27 i'm not sure what alpine's long-term mission is. if it really wants to get into being all things to all people 2024-01-18 19:44:21 it's part of the reason i haven't come in with PRs when i see problems on desktop. like, this isn't really alpine's thing, i should probably just kludge it and move on. 2024-01-18 19:45:36 Well, there is little reason to not fix things if you can 2024-01-18 19:46:39 just trying to avoid the bikeshed 2024-01-18 19:46:52 bikeshed coloring 2024-01-18 19:46:57 its more of how much resource/support, if someone can its always welcomed 2024-01-18 19:47:10 We get a lot of desktop support through pmos 2024-01-18 19:48:38 i would say, pick al as base, spin a desktop distro 2024-01-18 19:49:01 build another community around it 2024-01-18 19:49:39 maybe but that's assuming they'd have all their own repos and infra 2024-01-18 19:49:48 and who's going to do it 2024-01-18 19:49:58 gradually both community benifits 2024-01-18 19:50:24 that's the question, resource/support 2024-01-18 19:50:29 having the infra is the hardest part 2024-01-18 19:50:37 yep 2024-01-18 19:51:41 tbh, i'm kind of on the sunset end of things. i've been committer at freebsd, gentoo and elsewhere. even if i know how to do all of that, i don't have the time & energy anymore :-/ 2024-01-18 19:52:32 like i would probably be able to chip in a little on the docs idea i put forward, if people find it has merit 2024-01-18 19:52:57 because i think that just eats up people's time on the other side (irc support, so on) 2024-01-18 19:53:25 so this isn't my baby, but i think like a manager, i hate to see people's time get chewed up 2024-01-18 19:55:28 it's almost my life's purpose now, to keep people from burning out. 2024-01-18 19:55:53 it's happened too much, under my watch too, and i can't wash it off. 2024-01-18 19:57:10 Yeah, burn-out is a real problem 2024-01-18 19:59:31 i gotta run. caretaking duties. if you think the docs->wiki linking makes sense, i can help a bit. let me know 2024-01-18 20:00:46 btw i get that docs should be focused mainly on what alpine provides. maybe the thing to do in the short term is make the wiki stuff more explicit that it's zero-warranty 2024-01-18 20:03:02 or improve by adding al version to page or each section 2024-01-18 20:05:09 the problem, as i see it, is that the wiki is outside of gitlab 2024-01-18 20:05:23 gitlab is where the work is, the review process, et al 2024-01-18 20:05:44 indeed 2024-01-18 21:49:43 would it be an idea to move the wiki to gitlab wiki? 2024-01-18 21:50:33 i know mediawiki is pretty powerful when it comes to maintain the pages, find referenced pages, move pages etc 2024-01-18 21:51:37 or maybe we could move the handbook to gitlab wiki? 2024-01-18 21:53:36 i like the idea of the whole wiki to be git based 2024-01-18 21:54:38 same 2024-01-18 21:55:20 invoked: i think contributing to docs one way or the other would be valuable 2024-01-18 21:55:38 i like for example the openbsd doc quality 2024-01-18 21:55:45 they keep a lot in man pages 2024-01-18 21:55:45 yeah 2024-01-18 21:56:07 maybe an in tree wiki would be useful and package unspecific guides also gitbased as a handbook 2024-01-18 21:56:18 the info now is scattered and duplicated 2024-01-18 21:57:34 i think people write reference type of docs in wiki, because it is lacking other places 2024-01-18 21:57:39 and its easy to contribute there 2024-01-18 21:58:51 man pages are reference docs. I think we have man pages for lots of stuff, maybe most? 2024-01-18 21:59:10 i like this approach a lot 2024-01-18 21:59:33 but I think we should have an official user guide, admin guide or something official 2024-01-18 21:59:41 maybe use a md -> mandoc converter? 2024-01-18 21:59:43 and official developer docs 2024-01-18 21:59:51 i find both to be super important 2024-01-18 22:00:01 i research for open source alternatives to gitbook 2024-01-18 22:00:03 yeah, i think md as source for mandoc makes sense 2024-01-18 22:00:23 the official guides can reference to man pages 2024-01-18 22:00:41 they dont need to be "complete", but can point user to man docs 2024-01-18 22:00:59 for all details 2024-01-18 22:01:19 this sounds super 2024-01-18 22:01:38 the idea is that this doc can help you get started with things, and tell user where to find to complete reference 2024-01-18 22:01:54 thats the idea of docs.alpinelinux.org 2024-01-18 22:01:56 for example i installed my alpine desktop following a mix of three different wiki guides 2024-01-18 22:03:05 man pages can ref to other man pages, but shouldnt need to reference to the handbook 2024-01-18 22:03:13 link to handbook i mean 2024-01-18 22:03:28 this makes total sense, because they describe domain specific parts 2024-01-18 22:03:31 also handbook should not link to wiki.alpinelinux.org 2024-01-18 22:03:44 but wiki.a.o should link to handbook and manpages 2024-01-18 22:03:44 +1 2024-01-18 22:04:02 should i open an issue in gitlab where we can permanently discuss the topic? 2024-01-18 22:04:15 i think thats a good idea 2024-01-18 22:04:39 what we really need is someone who can take responsibility for it, and follow up 2024-01-18 22:04:51 and organize a docs team 2024-01-18 22:05:00 help involve more people to contribute to docs 2024-01-18 22:05:11 i feel the need to improve documentation 2024-01-18 22:05:12 we had a few in the past 2024-01-18 22:05:45 i have felt the need of improving the docs for years, but there is not enough hours on a day 2024-01-18 22:06:06 before that i would like to do two things: improve mkinitfs nlplug-findfs to have a source code file per filesystem and then add dm-integrity support 2024-01-18 22:06:10 i barely manage to keep my head above the surface 2024-01-18 22:06:15 after that i want to bring torbrowser 2024-01-18 22:06:59 i haven't had energy to start look at the dm-integrity thing yet 2024-01-18 22:07:02 i feel your issue. On the flip side alpine is somewhat of a niche distro that delivers and does not talk a lot (my feeling) 2024-01-18 22:07:31 heh. thanks! 2024-01-18 22:08:49 you're welcome. I love the result driven folks here :) 2024-01-18 22:09:51 we do have a docs team lead (nangel), but I don't think he has the needed time to do anything nowadays 2024-01-18 22:10:31 and before nangel we had chloe (who wrote the current handbook), but she also left 2024-01-18 22:11:08 i think that maybe the current docs.a.o is a bit to hard (for the right people) to contribute to 2024-01-18 22:11:57 unfortunately documentation comes last. I appreciate all the work in the wiki and transferring the info to man page and the handbook will help prolive the info further 2024-01-18 22:12:20 also having a git bound man and handbook helps to keep the code changes in sync with the doc 2024-01-18 22:12:29 (at least in theory) 2024-01-18 22:17:29 manpages are easier to keep up to date, as they can easily be updated together with the code 2024-01-18 22:17:44 yeah 2024-01-18 22:17:55 actually, that is a pretty good point there 2024-01-18 22:18:36 the sources for the install guide should probably be with alpine-conf, where the setup scripts are 2024-01-18 22:18:44 yes, that is true. It would be interesting if some codesegments in the handbook could be linked to commit states or smth 2024-01-18 22:19:20 https://gitlab.alpinelinux.org/alpine/docs/developer-handbook/-/issues/7 2024-01-18 22:19:41 im thinking the docs for unattended instals should go with tiny-cloud docs 2024-01-18 22:19:42 but... 2024-01-18 22:20:15 tiny-cloud is not alpine specific, at least that is the goal afaik 2024-01-18 22:20:33 so it doesnt make sense to have alpine specific stuff there 2024-01-18 22:20:34 i have never used it, because i only operate on bare metal 2024-01-18 22:20:47 i would unfotunately go afk for today :) 2024-01-18 22:20:52 *:/ 2024-01-18 22:20:58 have a nice evening! 2024-01-18 22:21:00 thanks! 2024-01-18 22:21:03 thanks for the nice discussion! 2024-01-18 22:21:11 for you too! 2024-01-18 22:21:26 so thinking out loud, it makes absolutely best sense to have man pages for tiny-cloud 2024-01-18 22:22:16 have an alpine specific guide for how to use tiny-cloud in alpine context (et unattended installs), and link to tiny-cloud man pages for full reference 2024-01-19 01:38:27 Can we get a bump on https://wiki.alpinelinux.org/wiki/MediaWiki:Copyright ? 2024-01-19 01:39:00 I do believe that accepts wikimarkup, so suggest changing `2021` to something like {{REVISIONYEAR:Template:AlpineLatest}} or even {{CURRENTYEAR}} 2024-01-19 01:39:07 then it never has to be messed with again. :p 2024-01-19 18:29:26 gitlab's wiki sucks, no other way to put it 2024-01-19 18:29:53 wikijs can use gitlab as a backend, that might be food for thought 2024-01-19 18:30:06 Yeah, no MRs at all for wikis iirc 2024-01-19 18:30:37 well just the wiki itself in terms of how it works is a joke. it's barely better than nothing. 2024-01-19 18:31:36 but wikijs on the other hand, is decent and integrated with gitlab, i think it can follow the usual review process 2024-01-19 18:31:46 i'm not 100% sure about that, though 2024-01-19 18:35:40 https://docs.requarks.io/storage/git this says "coming soon!" but https://cfreeman.cloud/wiki-js-on-docker-with-gitlab-storage-backend/ is one way to do it. 2024-01-19 18:36:02 scroll down for self-hosted gitlab 2024-01-19 18:40:11 i think importing from mediawiki might be a pita, however. 2024-01-19 18:40:29 probably will lose page history, at the very least. 2024-01-19 18:41:10 And links will break as well 2024-01-19 18:41:16 which I'm not a fan of 2024-01-19 18:41:43 but one backend to rule them all 2024-01-19 18:41:47 :) 2024-01-19 18:42:51 opinions being what they are, if wikijs + gitlab works as expected, the tradeoffs would be worth it 2024-01-19 18:43:12 just a short term headache 2024-01-19 18:50:18 don't know about it, maybe setup in readonly mode first 2024-01-19 18:51:39 does it use gitlab api ? 2024-01-19 18:52:06 apparently it does 2024-01-19 18:52:09 it needs the API url 2024-01-19 18:53:18 i think MRs and stuff will work, but what isn't clear is if we use social auth for wikijs instead of requiring a gitlab account, how that works. 2024-01-19 18:53:27 or if it does.