@ljrk @sindarina @miki In documentation of all places you do have the ability to actually write that this value needs to be changed though.
"Important: insert the IP address of [whatever] here"
Top-level
@ljrk @sindarina @miki In documentation of all places you do have the ability to actually write that this value needs to be changed though. "Important: insert the IP address of [whatever] here" 9 comments
@benaryorg That's why I wouldn't put 1.2.3.4 in docs/example configs for... idk, a BGP router or something lol. As I said, it really comes down to the target group, and if I get more confusing/questions about 192.0.2.0/24 and it holds up students or confuses them, I tend to use 1.2.3.4 (it's mostly oral lectures, although I hate giving lectures). @benaryorg @sindarina @miki Look, you made a lot of great points. It just so happens I know them and agree with them. I even did argue that these were invalid points. I just made counter points that are, unfortunately, true as well. You chose not to engage with them, which is fine, but there's seriously no point in having a discussion where you repeat all those – good! – points that are well known and accepted. |
@benaryorg @sindarina @miki Yep, and observe how people ignore it. Anyone who believes that documentation is actually read is naïve.
Everything that can be "self-documenting", i.e., *self explanatory* and obvious should be made/written like that. Any "surrounding" documentation is less likely to be read.