unofficial mirror of guix-patches@gnu.org 
 help / color / mirror / code / Atom feed
From: "Ludovic Courtès" <ludo@gnu.org>
To: "Pierre-Henry Fröhring" <contact@phfrohring.com>
Cc: 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 14:36:00 +0100	[thread overview]
Message-ID: <877d9vx7b3.fsf_-_@gnu.org> (raw)
In-Reply-To: <089df39f323ee4b4bb83b6b7e0cc8f262a9317e5.camel@phfrohring.com> ("Pierre-Henry Fröhring"'s message of "Tue, 15 Feb 2022 11:10:24 +0100")

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.

But maybe we can have both, with cross references.

Thoughts?

Ludo’.




  reply	other threads:[~2022-02-16 13:39 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 [this message]
2022-02-16 14:36         ` zimoun
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=877d9vx7b3.fsf_-_@gnu.org \
    --to=ludo@gnu.org \
    --cc=53827@debbugs.gnu.org \
    --cc=contact@phfrohring.com \
    --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).