!avYyleMexqjFHoqrME:nixos.org

Nix Documentation

401 Members
Discussion about documentation improvements around the Nix ecosystem80 Servers

Load older messages


SenderMessageTime
5 Apr 2024
@danielsidhion:nixos.devdanielsidhionMaybe "nix(pkgs) reference (material|documentation|book)" and "nixos user guide", and avoid any misunderstanding with the word manual entirely?11:02:36
@anderson_torres:matrix.orgAnderson TorresWhat we have that would be equiv to A handbook?12:59:10
@infinisil:matrix.orginfinisilMaybe just "Nix[pkgs] reference"18:31:47
@anderson_torres:matrix.orgAnderson Torres* What we have that would be equiv to a handbook?21:28:46
@anderson_torres:matrix.orgAnderson Torreshum, I feel it lacks something like The FreeBSD Handbook.21:30:49
@fractivore:cyberia.club@fractivore:cyberia.clubI 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
@fricklerhandwerk:matrix.orgfricklerhandwerk
In reply to @fractivore:cyberia.club
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?
Absolutely, feel free to join any time
01:18:16
@janejasperous:nadanix.comJane JasperousDiataxis documentation framework put some light into the Manual vs Tutorial thing16:58:55
@janejasperous:nadanix.comJane Jasperous * Diataxis documentation framework put some light into the How-to Guides vs Tutorial thing16:59:20
@janejasperous:nadanix.comJane Jasperoushttps://diataxis.fr/tutorials-how-to/16:59:28
7 Apr 2024
@arilebedey:matrix.orgarilebedey joined the room.04:51:21
@fractivore:cyberia.club@fractivore:cyberia.club changed their display name from symys to symyƨ.07:58:04
@fractivore:cyberia.club@fractivore:cyberia.club changed their display name from symyƨ to sγmγƨ.08:00:52
@fractivore:cyberia.club@fractivore:cyberia.club changed their display name from sγmγƨ to SYMYƧ.08:08:31
@efun:matrix.orgefun joined the room.21:58:06
9 Apr 2024
@djacu:matrix.orgdjacu changed their profile picture.23:22:58
10 Apr 2024
@technicus:matrix.orgMiles DysonHey 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
@fractivore:cyberia.club@fractivore:cyberia.club
In reply to @technicus:matrix.org
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?

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 configuration.nix.

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
@fractivore:cyberia.club@fractivore:cyberia.club
In reply to @technicus:matrix.org
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?
*

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 configuration.nix. After doing the installation, demoing configuration.nix and answering some questions, you'll have given as much information as people can handle. Just a suggestion, of course.

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
@fractivore:cyberia.club@fractivore:cyberia.clubBottom line: covering only a small amount of material is a good idea for this sort of context.05:23:33
@technicus:matrix.orgMiles Dyson
In reply to @fractivore:cyberia.club
Bottom line: covering only a small amount of material is a good idea for this sort of context.

Thanks for the advice!

We have two hours, I figure setting up the demo and guiding people through the install could go on for about an hour (pending technical challenges).

Then we could chat and I could respond with questions.

After, maybe do some one on one assistance.

It is a small group, between five and ten people, and most all have relatable experience with GNU/Libre/Linux software.

05:30:22
@technicus:matrix.orgMiles DysonA couple of friends of mine asked me if I could tutor their kids. I am going to try crafting a progressive lesson series. Maybe once or twice a month, meet with them and help with what they want to know or might have difficulty with, and when they are ready or as needed develop new lessons and tutorials to help them out. So I figure to avoid being stumped when they ask me questions, I should get to know all that I can for myself.05:38:14
@technicus:matrix.orgMiles DysonThe one question that was asked which inspired me to start studying was about the pillars of Reproduciblity, Declarativity and Immutability. I was a little stumped when trying to explain the concepts, and the next time I get asked . . . it would be great if I could reply with definitive concise explanations and provide examples.05:52:41
@fractivore:cyberia.club@fractivore:cyberia.club
In reply to @technicus:matrix.org
A couple of friends of mine asked me if I could tutor their kids.

I am going to try crafting a progressive lesson series.

Maybe once or twice a month, meet with them and help with what they want to know or might have difficulty with, and when they are ready or as needed develop new lessons and tutorials to help them out.

So I figure to avoid being stumped when they ask me questions, I should get to know all that I can for myself.
It's great to try to avoid getting stumped, but like, sometimes even professors teaching the same class for 20 years will get stumped by a student's question. That's what makes teaching such a great way to learn, the new perspectives that one can't anticipate on one's own! Don't be afraid to admit when you aren't sure about something - it can be a great way to model a good learning attitude, as well as a demonstration of how to get more information on something you're not sure about. Don't be afraid to look stuff up, live, and figure it out alongside your peers.
06:29:07
@fractivore:cyberia.club@fractivore:cyberia.club
In reply to @technicus:matrix.org
The one question that was asked which inspired me to start studying was about the pillars of Reproduciblity, Declarativity and Immutability.

I was a little stumped when trying to explain the concepts, and the next time I get asked . . . it would be great if I could reply with definitive concise explanations and provide examples.
Like, about the definitions of those terms?
06:29:30
@olafklingt:matrix.org@olafklingt:matrix.org Miles Dyson: for the case you like to focus on using nixos on desktops ... starting from nix and using it to create nixos-vms and then edit the configuration can be a good focus.
I think this is a easier task then developer environments or packaging.
16:34:42
@infinisil:matrix.orginfinisil I won't be in the docs team meeting tomorrow (cc fricklerhandwerk) 21:00:39
11 Apr 2024
@technicus:matrix.orgMiles Dyson
In reply to @fractivore:cyberia.club
Like, about the definitions of those terms?
Yes, specifically immutability. I said that I am still new to Nix and only have a vague idea, but I would look into it more and at our next gathering include an explanation in my presentation.
00:15:51
@fractivore:cyberia.club@fractivore:cyberia.club
In reply to @technicus:matrix.org
Yes, specifically immutability. I said that I am still new to Nix and only have a vague idea, but I would look into it more and at our next gathering include an explanation in my presentation.
Hmm, searching around for basic explanations on this, there aren't a lot of great options. So I think it's something that could be better introduced in learning resources geared towards beginners and outsiders who might be considering NixOS.
01:34:48
@fractivore:cyberia.club@fractivore:cyberia.club"Immutable" is a property of data. It means the data can't be modified after it's first created. Rather than write a lengthy post here, I'll put something on the wiki that I can link you to.01:37:46

Show newer messages


Back to Room ListRoom Version: 6