GNU bug report logs - #74046
[PATCH] doc: Add "Contributing to Guix's infrastructure".

Previous Next

Full log

Message #23 received at 74046 <at> debbugs.gnu.org (full text, mbox):

From: Ekaitz Zarraga <ekaitz <at> elenq.tech>
To: Ludovic Courtès <ludo <at> gnu.org>
Cc: Maxim Cournoyer <maxim.cournoyer <at> gmail.com>, code <at> greghogan.com,
 74046 <at> debbugs.gnu.org
Subject: Re: [bug#74046] [PATCH v2] doc: Add "Contributing to Guix's
 infrastructure".
Date: Wed, 20 Nov 2024 23:58:57 +0100

[Message part 1 (text/plain, inline)]

Hi,

> I think it’s a good idea.  I have some reservations about the style, as
> Greg already noted :-), and the fact that some of the info is quite
> detailed and might become outdated rather quickly.  But I think the
> result is still a big improvement, and that outweighs the “risks”.

I just copied what you wrote :)

If it becomes outdated we could update... that's the good part of a 
living document. We have thousands of software packages in the same 
repository, that become outdated way faster than the documentation. I 
think we should encourage people to update documentation as we do with 
the packages. Still, I agree with what you say, it can be hard to keep 
up with translations.

We could evolve it to become more generic so it doesn't need that many 
updates, but still keep the essence that people should pay attention to 
the fact that we need help with the infrastructure.

>> +@node Contributing to Guix's infrastructure
>> +@section Contributing to Guix's infrastructure
> 
> Nitpick: Could you use title case for all section/node titles?

Ok

>> +@itemize
>> +@item Build Farm Front-End: @url{https://git.cbaines.net/guix/bffe}
>> +@item Cuirass: @url{https://guix.gnu.org/cuirass/}
> 
> To improve rendering, especially in HTML, could you use two-argument
> @url as shown below, for all the URLs?
> 
>    @url{https://guix.gnu.org/cuirass/, Cuirass}

Sure.

>> +Prerequisite: Being a “known” member of the community, familiarity with Guix
>> +System administration, with some of the services/web sites being run, and with
>> +the infrastructure handbook:
>> +
>> +@url{https://git.savannah.gnu.org/cgit/guix/maintenance.git/tree/doc/infra-handbook.org}
> 
> the
> @uref{https://git.savannah.gnu.org/cgit/guix/maintenance.git/tree/doc/infra-handbook.org,
> infrastructure handbook}.
> 
>> +We need hosting of “small” machines such as single-board computers (AArch64,
> 
> Quotes should be written ``like this'' to make sure nothing goes wrong
> with the various Texinfo backends.

Ok

> Could you send an updated version?

Find it attached.

> Thanks!
> 
> Ludo’.

Thank you!


> PS: At some point we should prolly consider make the “Contributing”
>      chapter to a separate document altogether.

It depends on if we consider contributing is really part of how to use 
Guix or not. I'm ok with keeping it here but also with moving it 
somewhere else.

[v3-0001-doc-Add-Contributing-to-Guix-s-infrastructure.patch (text/x-patch, attachment)]

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.