unofficial mirror of guix-devel@gnu.org 
 help / color / mirror / code / Atom feed
From: "Ludovic Courtès" <ludo@gnu.org>
To: zimoun <zimon.toutoune@gmail.com>
Cc: Guix Devel <guix-devel@gnu.org>
Subject: Re: doc: Channel subsection order?
Date: Wed, 16 Sep 2020 18:39:47 +0200	[thread overview]
Message-ID: <87een1n0a4.fsf@gnu.org> (raw)
In-Reply-To: <CAJ3okZ2i7hBOQaME=P4yLBQPYx3WH=W6i4JNKzq-51xLu9-jRQ@mail.gmail.com> (zimoun's message of "Sat, 12 Sep 2020 00:49:34 +0200")

Hi!

zimoun <zimon.toutoune@gmail.com> skribis:

> I was re-reading the section about Channels and the subsections do not
> appear to me "logical".  Currently, it is:
>
>   1. Channel Authentication
>   2. Using a Custom Guix Channel
>   3. Specifying Additional Channels
>   4. Declaring Channel Dependencies
>   5. Package Modules in a Sub-directory
>   6. Specifying Channel Authorizations
>   7. Primary URL
>   8. Writing Channel News
>   9. Replicating Guix
>
> and to me, the progression when reading is smoother with this order:
>
>   1. Using a Custom Guix Channel
>   2. Specifying Additional Channels
>   3. Channel Authentication
>   4. Declaring Channel Dependencies
>   etc.

Yes, I agree!

I think we should:

  1. Move “Channels” to the top level, with real subsections as nodes.

  2. Clearly distinguish between using a channel and developing a
     channel.  The former should come first.

  3. Probably move ‘guix pull’ and ‘guix time-machine’ under that
     section.

  4. Add a tutorial-like section on how to work on your own channel.

Thoughts?

Ludo’.


  parent reply	other threads:[~2020-09-16 16:40 UTC|newest]

Thread overview: 7+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-09-11 22:49 doc: Channel subsection order? zimoun
2020-09-12 10:14 ` Pierre Neidhardt
2020-09-16 16:39 ` Ludovic Courtès [this message]
2020-09-16 18:58   ` zimoun
2020-09-18  1:44   ` zimoun
2020-09-18 12:19     ` Ludovic Courtès
2020-09-18 20:12       ` zimoun

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=87een1n0a4.fsf@gnu.org \
    --to=ludo@gnu.org \
    --cc=guix-devel@gnu.org \
    --cc=zimon.toutoune@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 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).