From: zimoun <zimon.toutoune@gmail.com>
To: "Ludovic Courtès" <ludo@gnu.org>
Cc: "Pierre-Henry Fröhring" <contact@phfrohring.com>,
53827@debbugs.gnu.org, "Maxime Devos" <maximedevos@telenet.be>
Subject: [bug#53827] [PATCH] Add a TLDR entry to the cookbook for building Guix from Git.
Date: Wed, 16 Feb 2022 15:36:04 +0100 [thread overview]
Message-ID: <CAJ3okZ1_4oEvfz5CFrruHPT9ChZjnHq=kjoiwVQLbcv5Hz0Btg@mail.gmail.com> (raw)
In-Reply-To: <877d9vx7b3.fsf_-_@gnu.org>
Hi,
On Wed, 16 Feb 2022 at 14:39, Ludovic Courtès <ludo@gnu.org> wrote:
>
> Hi,
>
> Pierre-Henry Fröhring <contact@phfrohring.com> skribis:
>
> > I try to make Guix our default package manager. It's really wonderful
> > so far. To that end, I need TLDRs so that less experienced
> > developpers can get going /fast/. Deeper understanding will come in
> > time.
> >
> > I also need to convince that Guix is /easy/ to third parties. I need
> > to /show/ that /installing/, /configuring/ and /using/ Guix is fast
> > and efficient. I found out that TLDRs are great tools for that.
> >
> > I need to have small TLDRs so that when things go wrong, it's easy to
> > know where and fix either the TLDR or the manual steps. Also,
> > sometimes, things go wrong and are not documented. /E.g./ setting
> > ~LC_ALL=C.UTF-8~ will make Guix complain even after installing ~guix
> > install glibc-utf8-locales~. I can factor this knowledge inside these
> > TLDR fast.
>
> No argument here, I very much understand why as a user or potential
> contributor one would want to-the-point documentation as a first step.
>
> I also want to be able to understand what I’m doing though—maybe not at
> first, but soon enough. That’s why I don’t feel comfortable giving a
> raw list of commands without explanations.
For what it is worth, I wrote a version for some users here:
<https://simon.tournier.info/posts/2021-10-12-add-guix-package.html>
The manual is good (even really good!) once I am able to explicitly
formulate what I want. That's the job of the Cookbook (or any other
materials): fill the gap, IMHO.
Cheers,
simon
next prev parent reply other threads:[~2022-02-16 14:37 UTC|newest]
Thread overview: 17+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-02-06 21:33 [bug#53827] [PATCH] Add a TLDR entry to the cookbook for building Guix from Git Pierre-Henry Fröhring
2022-02-06 22:02 ` Maxime Devos
2022-02-15 9:20 ` Ludovic Courtès
2022-02-15 10:10 ` Pierre-Henry Fröhring
2022-02-16 13:36 ` Ludovic Courtès
2022-02-16 14:36 ` zimoun [this message]
2022-02-16 15:50 ` Pierre-Henry Fröhring
2022-02-16 16:16 ` Leo Famulari
2022-02-16 20:37 ` Pierre-Henry Fröhring
2022-02-17 10:38 ` Ludovic Courtès
2022-02-06 22:02 ` Maxime Devos
2022-02-06 22:03 ` Maxime Devos
2022-02-06 22:06 ` Maxime Devos
2022-02-06 22:07 ` Maxime Devos
2022-02-06 22:09 ` Maxime Devos
2022-02-06 23:10 ` Pierre-Henry Fröhring
2022-02-06 23:03 ` [bug#53827] [PATCH] Add a TLDR entry " Pierre-Henry Fröhring
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
List information: https://guix.gnu.org/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to='CAJ3okZ1_4oEvfz5CFrruHPT9ChZjnHq=kjoiwVQLbcv5Hz0Btg@mail.gmail.com' \
--to=zimon.toutoune@gmail.com \
--cc=53827@debbugs.gnu.org \
--cc=contact@phfrohring.com \
--cc=ludo@gnu.org \
--cc=maximedevos@telenet.be \
/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 public inbox
https://git.savannah.gnu.org/cgit/guix.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).