[Nix-dev] [RFC] Generating documentation from nixpkgs (markdown files) with pandoc (Was: Real documentation, aka "Let's kill the wiki")

I created a showcase on how to generate documentation from the nixpkgs tree: https://github.com/matthiasbeyer/nixpkgs/tree/pandoc-documentation Note: 1) The documentation is still generated from .md files, not by parsing .nix files. This could be changed, but isn't trivial.

Re: [Nix-dev] Real documentation, aka "Let's kill the wiki"

You have to think about the audience. In general following should cover us: - tutorial (how do I get quickly update to date on X topic) - user guide (how does a specific feature work) - reference (functions and what they do) Currently that's all bundled throughout the manual (and wiki). Domen

Re: [Nix-dev] Real documentation, aka "Let's kill the wiki"

On 18 nov. 2015, at 16:00, Augustin Borsu wrote: > What about having a documentation field in pkgs that allows for markdown? > Can't get closer to the code than that. This. Documentation that’s seperated from code always rots. Even when you hire technical writers...

Re: [Nix-dev] Real documentation, aka "Let's kill the wiki"

Hajo Möller writes: > As mentioned in another thread, Rok Garbas proposed to remove the wiki > and replace it with "real documentation". I fully support this. > > To follow up on this proposal I suggest we decide what real > documentation should look like, so let us reiterate

Re: [Nix-dev] [RFC] Generating documentation from nixpkgs (markdown files) with pandoc

Hi folks, this may not be obvious, so I felt I should better point out that the Haskell part of the User Manual is already generated from Markdown. See doc/haskell-users-guide.md and doc/default.nix for further details. Best regards, Peter ___ nix-dev

[Nix-dev] Documentation on the Genode port

I've started writing some documentation on the Nix to Genode port, and I have an explaination for some of the demo during Nixcon. Its fringe stuff but I'll try and keep some notes together if someone else wants to do some cross platform stuff. https://ehmry.github.io/ Cheers, Emery

[Nix-dev] Hamburg NixOS Meetup

Hi there, are there any fellow Nixers in Hamburg who want to meet up from time to time? I thought about creating a meetup.com page for organization but wanted to check if there is some interest first. Regards, Pascal signature.asc Description: OpenPGP digital signature

Re: [Nix-dev] [RFC] Generating documentation from nixpkgs (markdown files) with pandoc (Was: Real documentation, aka "Let's kill the wiki")

I've once experimented and ported nixpkgs manual to http://static.domenkozar.com/nixpkgs-manual-sphinx-exp/ But there doesn't seem to be of a much interest to make documentation more approachable (something we did with github for code) On Wed, Nov 18, 2015 at 6:47 PM, Matthias Beyer

Re: [Nix-dev] Hamburg NixOS Meetup

Sure, let's do this. How about meeting irregularly for good coffee and a snack around midday? -- Regards, Hajo Möller ___ nix-dev mailing list nix-dev@lists.science.uu.nl http://lists.science.uu.nl/mailman/listinfo/nix-dev

Re: [Nix-dev] Documentation on the Genode port

Thanks, Emery - I'm a big fan of both Nix (obviously) and also Genode, so I have been very pleased to see your lightning talk and now this writeup :) Cheers, - Tim. On Thu, Nov 19, 2015 at 5:37 AM, Emery Hemingway wrote: > I've started writing some documentation on the Nix

Re: [Nix-dev] Hamburg NixOS Meetup

I'm in! On Wed, Nov 18, 2015, at 07:43 PM, Pascal Wittmann wrote: > Hi there, > > are there any fellow Nixers in Hamburg who want to meet up from time to > time? I thought about creating a meetup.com page for organization but > wanted to check if there is some interest first. > > Regards, >

Re: [Nix-dev] Hydra.nixos.org problems

stan appears to be out of disk space http://hydra.nixos.org/build/27896328 On Tue, Nov 17, 2015 at 5:05 PM, Vladimír Čunát wrote: > Hi, > We're getting lots of Hydra errors saying: > Aborted: cannot connect to ‘root@kenny’: Connection closed by > 131.180.119.71 > > It seems to

Re: [Nix-dev] [PATCH] pulseaudio: Add support for package configuration files.

On Wed, Nov 18, 2015 at 10:02:33AM +0100, Luca Bruno wrote: > I hope somehow will review this. Personally I'd prefer if you made a > pull request on github. While github allows use of its services for registered users without nonfree javascript, unfortunately it doesn't allow you to register

Re: [Nix-dev] Oliver Charles Talk

Hi Stewart, Glad you liked the talk! I will be tidying things up - probably tomorrow - and publishing a blog post on this, and I should be able to have an accompanying Github repository of relevant code. Keep an eye on https://ocharles.org.uk/blog (there are RSS feeds if you use a feed reader).

[Nix-dev] [call for] Release manager for Hydra

Hi all, at NixCon we had a discussion about having releases for Hydra. Mainly to well, know what git commit is considered stable. There seemed to be quite some interest, but to make that happen we need someone to volunteer to be a release manager. They would be doing QA that the release works

Re: [Nix-dev] [PATCH] pulseaudio: Add support for package configuration files.

On 17/11/2015 21:39, Jookia wrote: > In a fashion like udev's support, this patch allows configurations from > packages > to be merged in to directories for PulseAudio to read from. Currently > supported > directories are the alsa-mixer mdoule's profile-sets and paths. > > This is accomplished

Re: [Nix-dev] Pass arguments to 'required' configs

Nicolas, this solution makes sense if I understand how to include private modules to local configuration. (We are discussing this in a separate thread). Regards, Sergey 2015-11-17 17:55 GMT+03:00 Nicolas Pierron : > Hi Sergey, > > If you are not using the proxy_port

Re: [Nix-dev] [nix-dev] private NixOS modules

Hi Sergey, We have a some documenation in the NixOS Manual [1] which explains how to do that. To make it short, your configuration.nix file should have an import attribute which is a list of additional modules that you want to include. So if you file configuration.nix looks something like (a),

Re: [Nix-dev] [nix-dev] private NixOS modules

Oh, Thanks. I really should re-read the manual :) Sergey 2015-11-18 12:16 GMT+03:00 Nicolas Pierron : > Hi Sergey, > > We have a some documenation in the NixOS Manual [1] which explains how > to do that. To make it short, your configuration.nix file should have > an

Re: [Nix-dev] [nix-dev] private NixOS modules

Nicolas, I didn't know about NIXOS_EXTRA_MODULE_PATH, thanks. Could you explain other possible solution in a bit more details? How can we include modified module list in configuration.nix? Regards, Sergey 2015-11-17 17:43 GMT+03:00 Nicolas Pierron : > Hi Sergey, > >

Re: [Nix-dev] Pass arguments to 'required' configs

Sorry, I just noticed that you have modified my example radically. Looks like this is the answer to my question regarding custom modules, thanks! Sergey 2015-11-18 12:11 GMT+03:00 Sergey Mironov : > Nicolas, this solution makes sense if I understand how to include > private

Re: [Nix-dev] TexLive wiki page

On 18-11-2015 08:29:52, Karsten Gebbert wrote: > IMHO, the Github wiki should probably be that place, and the workflow > markdown/rst/org -> pandoc -> pdf/html (& possibly gh-pages). It makes it easy > to contribute via $EDITOR + git or a convenient web interface. > > My $0.02 :) > I'd vote

Re: [Nix-dev] Real documentation, aka "Let's kill the wiki"

I fully agree, and probably others too, but someone has to step up and lead that effort :) On Wed, Nov 18, 2015 at 3:04 PM, Hajo Möller wrote: > As mentioned in another thread, Rok Garbas proposed to remove the wiki > and replace it with "real documentation". I fully support

Re: [Nix-dev] Real documentation, aka "Let's kill the wiki"

On 18-11-2015 15:40:43, Domen Kožar wrote: > I fully agree, and probably others too, but someone has to step up and lead > that effort :) > As said in the other thread, I will try to get something basic working this weekend, if I have enough time. I'm not sure whether this falls into "step up

[Nix-dev] planet.nixos.org - a rss aggregation feed - add yourself

Hi, I would like to ask you to add yourself to the `planet.nixos.org` to have a channel where all the thoughts on nixos are aggregated. Fork the below repository, add yourself to the list and send a pull request:

Re: [Nix-dev] planet.nixos.org - a rss aggregation feed - add yourself

On 18-11-2015 14:20:42, Rok Garbas wrote: > I would like to ask you to add yourself to the `planet.nixos.org` to have > a channel where all the thoughts on nixos are aggregated. > > Fork the below repository, add yourself to the list and send a pull request: > > >

Re: [Nix-dev] TexLive wiki page

Quoting Matthias Beyer (2015-11-18 14:23:41) > On 18-11-2015 08:29:52, Karsten Gebbert wrote: > > IMHO, the Github wiki should probably be that place, and the workflow > > markdown/rst/org -> pandoc -> pdf/html (& possibly gh-pages). It makes it > > easy > > to contribute via $EDITOR + git or a

Re: [Nix-dev] [call for] Release manager for Hydra

On 18-11-2015 12:23:30, Peter Simons wrote: > Domen Kožar writes: > > > We need someone to volunteer to be a release manager. They would be > > doing QA that the release works and make sure changelog, docs, etc > > are updated. > > Also, we need a Hydra module for NixOS so that NixOS users

Re: [Nix-dev] Real documentation, aka "Let's kill the wiki"

On 18-11-2015 15:04:30, Hajo Möller wrote: > As mentioned in another thread, Rok Garbas proposed to remove the wiki > and replace it with "real documentation". I fully support this. Me too. > > "You should never tell somebody to read the source." > Even though the source code should be

[Nix-dev] Real documentation, aka "Let's kill the wiki"

As mentioned in another thread, Rok Garbas proposed to remove the wiki and replace it with "real documentation". I fully support this. To follow up on this proposal I suggest we decide what real documentation should look like, so let us reiterate his main points: "Why do we write documentation?"

Re: [Nix-dev] planet.nixos.org - a rss aggregation feed - add yourself

Quoting Matthias Beyer (2015-11-18 14:31:03) > On 18-11-2015 14:20:42, Rok Garbas wrote: > > I would like to ask you to add yourself to the `planet.nixos.org` to have > > a channel where all the thoughts on nixos are aggregated. > > > > Fork the below repository, add yourself to the list and send

Re: [Nix-dev] TexLive wiki page

On 18-11-2015 14:41:42, Rok Garbas wrote: > i would much rather see a discussion what to write and not how to write. > So you would like to see more blog posts, more tutorials and more stuff like that? So, something like my blog series about switching to nixos[0]? Or what are your ideas here?

Re: [Nix-dev] Real documentation, aka "Let's kill the wiki"

What about having a documentation field in pkgs that allows for markdown? Can't get closer to the code than that. Also generating an html doc of all the options of a package, their default value and maybe a comment by the author of the package and an example config would go a lng way. Le

[Nix-dev] Yet Another idea About the Wiki

I'm one of those people, who is new to Nix and is trying to learn it. What regards to the idea of killing the wiki, then I suggest that You just make a wiki that is editable only to the people, who have been with the project for a long time and know, what they are writing about. Once upon a time,

Re: [Nix-dev] Yet Another idea About the Wiki

Hi, I don't see how this proposal is better than just placing the documentation in some markup format in the nixpkgs repository itself. Compared to your proposed approach, that would have at least two advantages: * documentation is at least near to the code, making it easier to sync it with