guix-devel
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: Guix Documentation Meetup


From: Matt
Subject: Re: Guix Documentation Meetup
Date: Sun, 09 Jan 2022 16:12:57 -0500
User-agent: Zoho Mail

 > I see that this all seems confusing. 

Thank you for your response and for acknowledging my perspective.  Yes, I find 
many things about the documentation process confusing. I can't speak for 
others, but I get the strong sense that I'm not alone in that feeling.  

> If you have something to
> contribute, you should just mail it to this list or guix-patches.
> Definitely, we prefer you send patches, but if that is too hard, you can
> send your contribution in *any* form.

I did.  Maybe you missed the two blog posts I linked in the previous email?    

> I have two documents written in Org:
> 1. http://excalamus.com/test-guix-case-study-plover-python-dictionary.html
> 2. http://excalamus.com/2021-10-06-guix-debug.html

The first is a tutorial of creating a non-trivial Guix package.  The second 
analyzes the process of troubleshooting an issue.

I share them here for two reasons. 

First, the packaging tutorial is, I believe, a reasonable candidate for the 
cookbook.  It's ready for feedback toward inclusion, not direct inclusion.  The 
software being packaged isn't ideal as it involves concepts which may detract 
from the main subject of packaging, like stenography. It's also for a plugin 
and not standalone software.  Demonstrating the final package requires 
demonstrating the parent application which again detracts from the main subject 
of packaging.  Finally, it's written using active voice which conveys authority 
on the topic, authority I don't actually have. This was my first attempt at 
packaging.

Second, the troubleshooting post is not, in my option, suited for the cookbook. 
It is, however, a good candidate for a wiki page (similar to Arch wiki sections 
on troubleshooting).  The last time a wiki was talked about, it seems, was in 
2015. I'll start a thread for that.






reply via email to

[Prev in Thread] Current Thread [Next in Thread]