From: "Ludovic Courtès" <ludo@gnu.org>
To: Ekaitz Zarraga <ekaitz@elenq.tech>
Cc: Maxim Cournoyer <maxim.cournoyer@gmail.com>,
code@greghogan.com, 74046@debbugs.gnu.org
Subject: [bug#74046] [PATCH v2] doc: Add "Contributing to Guix's infrastructure".
Date: Wed, 20 Nov 2024 23:28:14 +0100 [thread overview]
Message-ID: <875xohv8u9.fsf@gnu.org> (raw)
In-Reply-To: <e661d69afb3a40516403cc722ecbbe73639d3892.1730970238.git.ekaitz@elenq.tech> (Ekaitz Zarraga's message of "Thu, 7 Nov 2024 10:03:58 +0100")
Hi!
Ekaitz Zarraga <ekaitz@elenq.tech> skribis:
> Use the "Call for contribution to the Guix infrastructure" by Ludovic
> Courtès to create a section in the documentation that describes how to
> contribute to the infrastructure.
>
> https://lists.gnu.org/archive/html/guix-devel/2024-05/msg00183.html
>
> * doc/contributing.texi (Contributing to Guix's infrastructure): New
> section.
>
> Change-Id: I3f3a99ad884110cc8323789e8c14bec1f7327e97
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”.
> +@node Contributing to Guix's infrastructure
> +@section Contributing to Guix's infrastructure
Nitpick: Could you use title case for all section/node titles?
> +@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}
> +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.
Could you send an updated version?
Thanks!
Ludo’.
PS: At some point we should prolly consider make the “Contributing”
chapter to a separate document altogether.
next prev parent reply other threads:[~2024-11-20 22:29 UTC|newest]
Thread overview: 7+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-10-27 12:45 [bug#74046] [PATCH] doc: Add "Contributing to Guix's infrastructure" Ekaitz Zarraga
2024-10-28 14:50 ` Greg Hogan
2024-11-03 18:51 ` Nicolas Graves via Guix-patches via
2024-11-20 22:16 ` Ludovic Courtès
2024-11-07 9:03 ` [bug#74046] [PATCH v2] " Ekaitz Zarraga
2024-11-20 22:28 ` Ludovic Courtès [this message]
2024-11-20 22:58 ` Ekaitz Zarraga
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=875xohv8u9.fsf@gnu.org \
--to=ludo@gnu.org \
--cc=74046@debbugs.gnu.org \
--cc=code@greghogan.com \
--cc=ekaitz@elenq.tech \
--cc=maxim.cournoyer@gmail.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this external index
https://git.savannah.gnu.org/cgit/guix.git
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.