Nix Documentation | 403 Members | |
| Discussion about documentation improvements around the Nix ecosystem | 83 Servers |
| Sender | Message | Time |
|---|---|---|
| 4 Apr 2024 | ||
| wamirez: I think you might have gotten update emails in the past, could you check? ^ | 16:05:25 | |
| * wamirez: I think you might have gotten update emails in the past, could you check that you don't anymore? ^ | 16:05:40 | |
In reply to @infinisil:matrix.orgDidn't get any update emails | 16:13:33 | |
| Nice, I think this might work then | 16:37:43 | |
| 19:57:05 | ||
| 21:11:48 | ||
| 5 Apr 2024 | ||
| quick thought: maybe reconsider calling everything a manual? Although it seems to be possible to call reference material "manual", the word often refers to more guide-like material | 09:33:27 | |
| I think the term "manual" is orthogonal to the purpose of the material. Both nix and nixpkgs manuals are actually named "reference manual" to explain their purpose (to be a reference). Personally I think the word "guide" is way more popular to refer to guide-like material (e.g. "user guide"). | 10:55:57 | |
| Sometimes people do use the term "manual" in the form "user manual" to refer to guide-like material, though | 10:56:35 | |
| Do you have a suggestion that would make things clearer? | 10:56:58 | |
| As for the nixos manual - I'd agree with renaming it to nixos user guide or nixos user manual or something like that | 10:59:02 | |
| Maybe "nix(pkgs) reference (material|documentation|book)" and "nixos user guide", and avoid any misunderstanding with the word manual entirely? | 11:02:36 | |
| What we have that would be equiv to A handbook? | 12:59:10 | |
| Maybe just "Nix[pkgs] reference" | 18:31:47 | |
| * What we have that would be equiv to a handbook? | 21:28:46 | |
| hum, I feel it lacks something like The FreeBSD Handbook. | 21:30:49 | |
| I burnt out quickly on the diagramming thing, but I would still like to help with documentation as I have energy. Are the doc team meetings open to everyone? | 23:17:11 | |
| 6 Apr 2024 | ||
In reply to @fractivore:cyberia.clubAbsolutely, feel free to join any time | 01:18:16 | |
| Diataxis documentation framework put some light into the Manual vs Tutorial thing | 16:58:55 | |
| * Diataxis documentation framework put some light into the How-to Guides vs Tutorial thing | 16:59:20 | |
| https://diataxis.fr/tutorials-how-to/ | 16:59:28 | |
| 7 Apr 2024 | ||
| 04:51:21 | ||
| 07:58:04 | ||
| 08:00:52 | ||
| 08:08:31 | ||
| 21:58:06 | ||
| 9 Apr 2024 | ||
| 23:22:58 | ||
| 10 Apr 2024 | ||
| Hey there, while attending a tech_meetup, during a discussion about operating systems . . . I mentioned that I recently installed NixOS and am getting to like it . . . as a result I was talked into giving a presentation about NixOS at the next meetup. I agreed to do a guided installation demo where participants would install and setup Nix on their machines. It looks like I am going to become a tutor . . . and in that roll I figure it would be wise for me to sift through all the documentation I can find. Obsidian seems like a useful tool to journal and make notes with, which is been helpful to get organized to try an teach a subject I know little about. Any advice? | 05:03:43 | |
In reply to @technicus:matrix.org I'd just say, you don't need to be an expert on the whole OS to explain what you like about it and walk people through the install! In other words, don't try to scope your tutorial too broadly. That breadth of knowledge will come in time, and only with time, so I suggest focusing on the desktop installation and first steps. You can only cover a little bit in a single talk and have the knowledge still be absorbable. Declarative system management is a new idea for a lot of people, so I suggest talking a little about how installing stuff with a config file differs from how it's done on more "traditional" distros, or windows or whatever. Demo the process of searching for a package on search.nixos.org (like https://search.nixos.org/packages?channel=unstable&from=0&size=50&sort=relevance&type=packages&query=discord) and installing the program via For stuff related to the basic installation, this wiki page might be a good place to start: https://wiki.nixos.org/wiki/NixOS_as_a_desktop | 05:19:53 | |
In reply to @technicus:matrix.org* I'd just say, you don't need to be an expert on the whole OS to explain what you like about it and walk people through the install! In other words, don't try to scope your tutorial too broadly. That breadth of knowledge will come in time, and only with time, so I suggest focusing on the desktop installation and first steps. You can only cover a little bit in a single talk and have the knowledge still be absorbable. Also, practice will help a lot if you want to be more confident when presenting. Declarative system management is a new idea for a lot of people, so I suggest talking a little about how installing stuff with a config file differs from how it's done on more "traditional" distros, or windows or whatever. Demo the process of searching for a package on search.nixos.org (like https://search.nixos.org/packages?channel=unstable&from=0&size=50&sort=relevance&type=packages&query=discord) and installing the program via For stuff related to the basic installation, this wiki page might be a good place to start: https://wiki.nixos.org/wiki/NixOS_as_a_desktop | 05:22:43 | |