all messages for Guix-related lists mirrored at yhetil.org
 help / color / mirror / code / Atom feed
From: "Ludovic Courtès" <ludo@gnu.org>
To: 34156@debbugs.gnu.org
Subject: [bug#34156] [PATCH 0/4] Re-organize the manual
Date: Mon, 21 Jan 2019 11:47:41 +0100	[thread overview]
Message-ID: <20190121104741.14511-1-ludo@gnu.org> (raw)

Hello Guix!

This is the great season cleanup of the manual.  I think it provides
a clearer view of what’s available.  Until now, the top-level chapters
were:

--8<---------------cut here---------------start------------->8---
* Introduction::                What is Guix about?
* Installation::                Installing Guix.
* Package Management::          Package installation, upgrade, etc.
* Programming Interface::       Using Guix in Scheme.
* Utilities::                   Package management commands.
* GNU Distribution::            Software for your friendly GNU system.
* Contributing::                Your help needed!
--8<---------------cut here---------------end--------------->8---

With these changes, that becomes:

--8<---------------cut here---------------start------------->8---
* Introduction::                What is Guix about?
* Installation::                Installing Guix.
* System Installation::         Installing the whole operating system.
* Package Management::          Package installation, upgrade, etc.
* Programming Interface::       Using Guix in Scheme.
* Utilities::                   Package management commands.
* System Configuration::        Configuring the operating system.
* Documentation::               Browsing software user manuals.
* Installing Debugging Files::  Feeding the debugger.
* Security Updates::            Deploying security fixes quickly.
* Bootstrapping::               GNU/Linux built from scratch.
* Porting::                     Targeting another platform or kernel.
* Contributing::                Your help needed!
--8<---------------cut here---------------end--------------->8---

Things about “the distro” in a broad sense are no longer hidden
under “GNU Distribution” and the introduction no longer ignores
Guix System.

Next up I’d like us to get rid of these catch-all “Utilities”
section and instead organize things by activities, such as
“Development”, “Distributing Substitutes”, and “Managing Storage
Space”.

Later I’d like to move each chapter to its own .texi file, which
will be nicer and will help Emacs build menus (currently it’s
confused because only one chapter leaves in a separate file.)

Thoughts?

Ludo’.

Ludovic Courtès (4):
  doc: Move sections under "GNU Distribution" one level higher.
  doc: Move "System Installation" right after "Installation".
  doc: Move "Packaging Guidelines" under "Contributing".
  doc: Move "Package Modules" under "Programming Interface".

 doc/contributing.texi |  450 ++++++++
 doc/guix.texi         | 2254 ++++++++++++++++-------------------------
 2 files changed, 1336 insertions(+), 1368 deletions(-)

-- 
2.20.1

             reply	other threads:[~2019-01-21 10:49 UTC|newest]

Thread overview: 7+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-01-21 10:47 Ludovic Courtès [this message]
2019-01-21 11:02 ` [bug#34156] [PATCH 1/4] doc: Move sections under "GNU Distribution" one level higher Ludovic Courtès
2019-01-21 11:02   ` [bug#34156] [PATCH 2/4] doc: Move "System Installation" right after "Installation" Ludovic Courtès
2019-01-21 11:02   ` [bug#34156] [PATCH 3/4] doc: Move "Packaging Guidelines" under "Contributing" Ludovic Courtès
2019-01-21 11:02   ` [bug#34156] [PATCH 4/4] doc: Move "Package Modules" under "Programming Interface" Ludovic Courtès
2019-01-22 22:20 ` bug#34156: [PATCH 0/4] Re-organize the manual Ludovic Courtès
2019-01-23  8:21   ` [bug#34156] " Ricardo Wurmus

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=20190121104741.14511-1-ludo@gnu.org \
    --to=ludo@gnu.org \
    --cc=34156@debbugs.gnu.org \
    /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.