From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from lists.gentoo.org (pigeon.gentoo.org [208.92.234.80]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits)) (No client certificate requested) by finch.gentoo.org (Postfix) with ESMTPS id D0A27158094 for ; Sun, 14 Aug 2022 19:29:04 +0000 (UTC) Received: from pigeon.gentoo.org (localhost [127.0.0.1]) by pigeon.gentoo.org (Postfix) with SMTP id 89711E0DA2; Sun, 14 Aug 2022 19:29:03 +0000 (UTC) Received: from smtp.gentoo.org (woodpecker.gentoo.org [140.211.166.183]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits)) (No client certificate requested) by pigeon.gentoo.org (Postfix) with ESMTPS id 67FADE0DA2 for ; Sun, 14 Aug 2022 19:29:03 +0000 (UTC) Received: from oystercatcher.gentoo.org (unknown [IPv6:2a01:4f8:202:4333:225:90ff:fed9:fc84]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits)) (No client certificate requested) by smtp.gentoo.org (Postfix) with ESMTPS id 41A323415E3 for ; Sun, 14 Aug 2022 19:29:02 +0000 (UTC) Received: from localhost.localdomain (localhost [IPv6:::1]) by oystercatcher.gentoo.org (Postfix) with ESMTP id C8AD553F for ; Sun, 14 Aug 2022 19:29:00 +0000 (UTC) From: "Ulrich Müller" To: gentoo-commits@lists.gentoo.org Content-Transfer-Encoding: 8bit Content-type: text/plain; charset=UTF-8 Reply-To: gentoo-dev@lists.gentoo.org, "Ulrich Müller" Message-ID: <1660505301.93ca68d1c57b2df5a1f7db33831e8d8a04183c74.ulm@gentoo> Subject: [gentoo-commits] data/glep:master commit in: / X-VCS-Repository: data/glep X-VCS-Files: glep-0013.rst X-VCS-Directories: / X-VCS-Committer: ulm X-VCS-Committer-Name: Ulrich Müller X-VCS-Revision: 93ca68d1c57b2df5a1f7db33831e8d8a04183c74 X-VCS-Branch: master Date: Sun, 14 Aug 2022 19:29:00 +0000 (UTC) Precedence: bulk List-Post: List-Help: List-Unsubscribe: List-Subscribe: List-Id: Gentoo Linux mail X-BeenThere: gentoo-commits@lists.gentoo.org X-Auto-Response-Suppress: DR, RN, NRN, OOF, AutoReply X-Archives-Salt: 010bd5ca-f98c-4477-8acc-ce6fa16dc009 X-Archives-Hash: 89b9957111d94411dc5c530f172e82e0 commit: 93ca68d1c57b2df5a1f7db33831e8d8a04183c74 Author: Ulrich Müller gentoo org> AuthorDate: Sun Aug 14 19:28:21 2022 +0000 Commit: Ulrich Müller gentoo org> CommitDate: Sun Aug 14 19:28:21 2022 +0000 URL: https://gitweb.gentoo.org/data/glep.git/commit/?id=93ca68d1 glep-0013: Delete trailing whitespace Signed-off-by: Ulrich Müller gentoo.org> glep-0013.rst | 38 +++++++++++++++++++------------------- 1 file changed, 19 insertions(+), 19 deletions(-) diff --git a/glep-0013.rst b/glep-0013.rst index 5846480..1b9be64 100644 --- a/glep-0013.rst +++ b/glep-0013.rst @@ -23,7 +23,7 @@ Abstract This GLEP provides a vision on the evolution of the Gentoo Documentation, namely a handbook-like document that provides its readers documentation about -every aspect of the Gentoo distribution: installation, administration, +every aspect of the Gentoo distribution: installation, administration, application usage, development etc. Motivation @@ -32,7 +32,7 @@ Motivation Gentoo's current Installation Guide [#InstGuide]_ is rapidly growing, being extended with more and more features that the Gentoo users can help with their quest for the perfect installation. This increase is needed and a Good Thing, -but it makes the guide less easy to read or use as reference. +but it makes the guide less easy to read or use as reference. There is no reason whatsoever that this evolution will stagnate, on the contrary: people start asking why the Alternative Installation Guide @@ -55,7 +55,7 @@ To address the beforementioned problem, there are two ideas: - Merge all information into one Big Handbook. This is of course an idea that we borrow from our FreeBSD friends [#FBSDHandBook]_ who already have an - extensive handbook related to their BSD-distribution. + extensive handbook related to their BSD-distribution. It is this second idea that this GLEP describes. @@ -70,9 +70,9 @@ Implementation ============== To implement such a handbook, the Gentoo Documentation Project [#GDP]_ needs a -rewritten stylesheet for its GuideXML [#GuideXML]_ format. Since there are no -problems with GuideXML itself, and since it is very flexible in its use, the -recommendation to stick with GuideXML is clear. We do need some extra features +rewritten stylesheet for its GuideXML [#GuideXML]_ format. Since there are no +problems with GuideXML itself, and since it is very flexible in its use, the +recommendation to stick with GuideXML is clear. We do need some extra features in GuideXML, without breaking the current GuideXML implementation. This last thing is important, since implementing this handbook-like document @@ -89,14 +89,14 @@ Guides, etc.) Other chapters that need to be put in place are: - A chapter on Gentoo Development, which embraces all current - development-specific guides, such as the Gentoo Developer HOWTO, the Gentoo - Policy, the Ebuild HOWTO, the Eclass HOWTO, etc. This has already been - frequently asked by the Gentoo ebuild maintainers and several other Gentoo - Developers. + development-specific guides, such as the Gentoo Developer HOWTO, the Gentoo + Policy, the Ebuild HOWTO, the Eclass HOWTO, etc. This has already been + frequently asked by the Gentoo ebuild maintainers and several other Gentoo + Developers. - A chapter specific to System Administration, such as Mailserver Administration, User Administration, Printing Administration etc. We already - have several guides that describe parts of these items. + have several guides that describe parts of these items. - A chapter specific to Gentoo Usage, including our popular Desktop Configuration Guide [#Desktop]_ and several Application-specific guides. @@ -124,8 +124,8 @@ information-division:: The ```` tag is currently a one-time tag: it defines the start of the guide, and of course the guide ends with ````. The ```` tag divides the document into separate chapters. However, -most of our documents have small chapters, whereas normal books and documents -have chapters that encompasses several pages. +most of our documents have small chapters, whereas normal books and documents +have chapters that encompasses several pages. The ``
`` tag further divides the chapter in which it resides. This means that our current installation guides have a division-depth of 2: @@ -150,7 +150,7 @@ The final implementation is in-document references. Currently, the Gentoo Documentation Developers have so guess in what chapter a certain section resides, and what section we are actually discussing: ``#doc_chap4_sect3`` provides us with a link to chapter 4, section 3. This is a workable -implementation for small documents, but impossible for handbooks. +implementation for small documents, but impossible for handbooks. Implementing a more HTML-alike reference inside the division-tags would be preferable: ````, ``