git: 2c5bff688d - main - Improve descriptions for some books and articles
Sergio Carlavilla
carlavilla at freebsd.org
Sun May 2 17:10:58 UTC 2021
On Sun, 2 May 2021 at 18:54, Allan Jude <allanjude at freebsd.org> wrote:
>
> The branch main has been updated by allanjude:
>
> URL: https://cgit.FreeBSD.org/doc/commit/?id=2c5bff688d8653c4306a2f6fdbb2c966eaee5a1c
>
> commit 2c5bff688d8653c4306a2f6fdbb2c966eaee5a1c
> Author: Allan Jude <allanjude at FreeBSD.org>
> AuthorDate: 2021-05-02 16:10:56 +0000
> Commit: Allan Jude <allanjude at FreeBSD.org>
> CommitDate: 2021-05-02 16:53:24 +0000
>
> Improve descriptions for some books and articles
>
> Also add weights to some, to define the sort order in the index
> Put the more commonly used items at the top of their respective lists
>
> The improved descriptions were taken from the old books/articles list:
> https://www.freebsd.org/docs/books/
>
> Sponsored-By: Klara Inc.
> ---
> .../content/en/articles/building-products/_index.adoc | 2 +-
> .../content/en/articles/committers-guide/_index.adoc | 3 ++-
> documentation/content/en/articles/contributing/_index.adoc | 3 ++-
> documentation/content/en/articles/contributors/_index.adoc | 2 +-
> .../content/en/articles/filtering-bridges/_index.adoc | 2 +-
> documentation/content/en/articles/fonts/_index.adoc | 2 +-
> documentation/content/en/articles/freebsd-releng/_index.adoc | 2 +-
> .../content/en/articles/freebsd-update-server/_index.adoc | 2 +-
> documentation/content/en/articles/geom-class/_index.adoc | 2 +-
> documentation/content/en/articles/hubs/_index.adoc | 2 +-
> documentation/content/en/articles/leap-seconds/_index.adoc | 2 +-
> .../content/en/articles/linux-emulation/_index.adoc | 2 +-
> .../content/en/articles/mailing-list-faq/_index.adoc | 2 +-
> documentation/content/en/articles/pam/_index.adoc | 2 +-
> .../content/en/articles/problem-reports/_index.adoc | 2 +-
> documentation/content/en/articles/rc-scripting/_index.adoc | 2 +-
> documentation/content/en/articles/releng/_index.adoc | 4 ++--
> documentation/content/en/articles/remote-install/_index.adoc | 2 +-
> documentation/content/en/articles/serial-uart/_index.adoc | 2 +-
> documentation/content/en/articles/solid-state/_index.adoc | 2 +-
> documentation/content/en/articles/vm-design/_index.adoc | 2 +-
> documentation/content/en/books/arch-handbook/_index.adoc | 3 ++-
> documentation/content/en/books/design-44bsd/_index.adoc | 3 ++-
> documentation/content/en/books/dev-model/_index.adoc | 3 ++-
> .../content/en/books/developers-handbook/_index.adoc | 3 ++-
> documentation/content/en/books/faq/_index.adoc | 3 ++-
> documentation/content/en/books/fdp-primer/_index.adoc | 3 ++-
> documentation/content/en/books/handbook/_index.adoc | 3 ++-
> documentation/content/en/books/porters-handbook/_index.adoc | 3 ++-
> documentation/themes/beastie/layouts/index.html | 12 ++++++++----
> 30 files changed, 48 insertions(+), 34 deletions(-)
>
> diff --git a/documentation/content/en/articles/building-products/_index.adoc b/documentation/content/en/articles/building-products/_index.adoc
> index 577b1d3d42..6c9a001278 100644
> --- a/documentation/content/en/articles/building-products/_index.adoc
> +++ b/documentation/content/en/articles/building-products/_index.adoc
> @@ -5,7 +5,7 @@ authors:
> email: jkoshy at FreeBSD.org
> organizations:
> - organization: The FreeBSD Project
> -description: Building Products with FreeBSD
> +description: How FreeBSD can help you build a better product
> trademarks: ["freebsd", "general"]
> ---
>
> diff --git a/documentation/content/en/articles/committers-guide/_index.adoc b/documentation/content/en/articles/committers-guide/_index.adoc
> index 7aad6a68ef..13cbb0c6a2 100644
> --- a/documentation/content/en/articles/committers-guide/_index.adoc
> +++ b/documentation/content/en/articles/committers-guide/_index.adoc
> @@ -3,8 +3,9 @@ title: Committer's Guide
> authors:
> - author: The FreeBSD Documentation Project
> copyright: 1999-2021 The FreeBSD Documentation Project
> -description: FreeBSD Committer's Guide
> +description: Introductory information for FreeBSD committers
> trademarks: ["freebsd", "coverity", "ibm", "intel", "general"]
> +weight: 25
> ---
>
> = Committer's Guide
> diff --git a/documentation/content/en/articles/contributing/_index.adoc b/documentation/content/en/articles/contributing/_index.adoc
> index c7d61004ec..6dab1d5096 100644
> --- a/documentation/content/en/articles/contributing/_index.adoc
> +++ b/documentation/content/en/articles/contributing/_index.adoc
> @@ -4,8 +4,9 @@ authors:
> - author: Jordan Hubbard
> - author: Sam Lawrance
> - author: Mark Linimon
> -description: Contributing to the FreeBSD Project
> +description: How to contribute to the FreeBSD Project
> trademarks: ["freebsd", "ieee", "general"]
> +weight: 15
> ---
>
> = Contributing to FreeBSD
> diff --git a/documentation/content/en/articles/contributors/_index.adoc b/documentation/content/en/articles/contributors/_index.adoc
> index afd0f120b4..fecc0e6fe6 100644
> --- a/documentation/content/en/articles/contributors/_index.adoc
> +++ b/documentation/content/en/articles/contributors/_index.adoc
> @@ -1,6 +1,6 @@
> ---
> title: Contributors to FreeBSD
> -description: Contributors to FreeBSD
> +description: A list of organizations and individuals who have contributed to FreeBSD
> trademarks: ["freebsd", "sun", "general"]
> ---
>
> diff --git a/documentation/content/en/articles/filtering-bridges/_index.adoc b/documentation/content/en/articles/filtering-bridges/_index.adoc
> index 7a3647c0fb..9ae472d44e 100644
> --- a/documentation/content/en/articles/filtering-bridges/_index.adoc
> +++ b/documentation/content/en/articles/filtering-bridges/_index.adoc
> @@ -3,7 +3,7 @@ title: Filtering Bridges
> authors:
> - author: Alex Dupre
> email: ale at FreeBSD.org
> -description: Filtering Bridges in FreeBSD
> +description: Configuring firewalls and filtering on FreeBSD hosts acting as bridges rather than routers
> trademarks: ["freebsd", "3com", "intel", "general"]
> ---
>
> diff --git a/documentation/content/en/articles/fonts/_index.adoc b/documentation/content/en/articles/fonts/_index.adoc
> index 70e52a1a91..34b12ba906 100644
> --- a/documentation/content/en/articles/fonts/_index.adoc
> +++ b/documentation/content/en/articles/fonts/_index.adoc
> @@ -4,7 +4,7 @@ subtitle: A Tutorial
> authors:
> - author: Dave Bodenstab
> email: imdave at synet.net
> -description: Description of the various font files that may be used with FreeBSD
> +description: A description of the various font technologies in FreeBSD, and how to use them with different programs
> trademarks: ["freebsd", "adobe", "apple", "linux", "microsoft", "opengroup", "general"]
> ---
>
> diff --git a/documentation/content/en/articles/freebsd-releng/_index.adoc b/documentation/content/en/articles/freebsd-releng/_index.adoc
> index 5615986124..bbb3f86ff9 100644
> --- a/documentation/content/en/articles/freebsd-releng/_index.adoc
> +++ b/documentation/content/en/articles/freebsd-releng/_index.adoc
> @@ -8,7 +8,7 @@ organizations:
> webpage: https://www.freebsdfoundation.org/
> - organization: Rubicon Communications, LLC (Netgate)
> webpage: https://www.netgate.com/
> -description: FreeBSD Release Engineering
> +description: Describes the approach used by the FreeBSD release engineering team to make production quality releases of the FreeBSD Operating System. It describes the tools available for those interested in producing customized FreeBSD releases for corporate rollouts or commercial productization
> trademarks: ["freebsd", "intel", "general"]
> ---
>
> diff --git a/documentation/content/en/articles/freebsd-update-server/_index.adoc b/documentation/content/en/articles/freebsd-update-server/_index.adoc
> index 6ee32d4eee..527067e752 100644
> --- a/documentation/content/en/articles/freebsd-update-server/_index.adoc
> +++ b/documentation/content/en/articles/freebsd-update-server/_index.adoc
> @@ -4,7 +4,7 @@ authors:
> - author: Jason Helfman
> email: jgh at FreeBSD.org
> copyright: 2009-2011, 2013 Jason Helfman
> -description: Build Your Own FreeBSD Update Server
> +description: Building your own freebsd-update server allows a system administrator to perform fast updates for a number of machines from a local mirror
> trademarks: ["freebsd", "amd", "intel", "general"]
> ---
>
> diff --git a/documentation/content/en/articles/geom-class/_index.adoc b/documentation/content/en/articles/geom-class/_index.adoc
> index 8c93697afb..902720e465 100644
> --- a/documentation/content/en/articles/geom-class/_index.adoc
> +++ b/documentation/content/en/articles/geom-class/_index.adoc
> @@ -3,7 +3,7 @@ title: Writing a GEOM Class
> authors:
> - author: Ivan Voras
> email: ivoras at FreeBSD.org
> -description: Writing a GEOM Class in FreeBSD
> +description: A guide to GEOM internals, and writing your own GEOM class
> trademarks: ["freebsd", "intel", "general"]
> ---
>
> diff --git a/documentation/content/en/articles/hubs/_index.adoc b/documentation/content/en/articles/hubs/_index.adoc
> index 3819b76d71..55f3b50f0e 100644
> --- a/documentation/content/en/articles/hubs/_index.adoc
> +++ b/documentation/content/en/articles/hubs/_index.adoc
> @@ -9,7 +9,7 @@ authors:
> email: dl at leo.org
> - author: Ken Smith
> email: kensmith at FreeBSD.org
> -description: How to mirror FreeBSD
> +description: The all in one guide for mirroring the FreeBSD website, FTP servers, and more
> trademarks: ["freebsd", "general"]
> ---
>
> diff --git a/documentation/content/en/articles/leap-seconds/_index.adoc b/documentation/content/en/articles/leap-seconds/_index.adoc
> index 8ad3c6154e..9dc11b3483 100644
> --- a/documentation/content/en/articles/leap-seconds/_index.adoc
> +++ b/documentation/content/en/articles/leap-seconds/_index.adoc
> @@ -1,6 +1,6 @@
> ---
> title: FreeBSD Support for Leap Seconds
> -description: FreeBSD Support for Leap Seconds
> +description: A short description of how leap seconds are handled on FreeBSD
> ---
>
> = FreeBSD Support for Leap Seconds
> diff --git a/documentation/content/en/articles/linux-emulation/_index.adoc b/documentation/content/en/articles/linux-emulation/_index.adoc
> index 701bf524cc..d5c6d985ed 100644
> --- a/documentation/content/en/articles/linux-emulation/_index.adoc
> +++ b/documentation/content/en/articles/linux-emulation/_index.adoc
> @@ -3,7 +3,7 @@ title: Linux® emulation in FreeBSD
> authors:
> - author: Roman Divacky
> email: rdivacky at FreeBSD.org
> -description: Linux® emulation in FreeBSD
> +description: A technical description about the internals of the Linux emulation layer in FreeBSD
> trademarks: ["freebsd", "ibm", "adobe", "netbsd", "realnetworks", "oracle", "linux", "sun", "general"]
> ---
>
> diff --git a/documentation/content/en/articles/mailing-list-faq/_index.adoc b/documentation/content/en/articles/mailing-list-faq/_index.adoc
> index 81bb9f2b07..f5b4eb064d 100644
> --- a/documentation/content/en/articles/mailing-list-faq/_index.adoc
> +++ b/documentation/content/en/articles/mailing-list-faq/_index.adoc
> @@ -3,7 +3,7 @@ title: Frequently Asked Questions About The FreeBSD Mailing Lists
> authors:
> - author: The FreeBSD Documentation Project
> copyright: 2004-2021 The FreeBSD Documentation Project
> -description: Frequently Asked Questions About The FreeBSD Mailing Lists
> +description: How to best use the mailing lists, such as how to help avoid frequently-repeated discussions
> ---
>
> = Frequently Asked Questions About The FreeBSD Mailing Lists
> diff --git a/documentation/content/en/articles/pam/_index.adoc b/documentation/content/en/articles/pam/_index.adoc
> index 6f3d5a22d6..03672f1ba2 100644
> --- a/documentation/content/en/articles/pam/_index.adoc
> +++ b/documentation/content/en/articles/pam/_index.adoc
> @@ -3,7 +3,7 @@ title: Pluggable Authentication Modules
> authors:
> - author: Dag-Erling Smørgrav
> copyright: 2001-2003 Networks Associates Technology, Inc.
> -description: Pluggable Authentication Modules (PAM) in FreeBSD
> +description: A guide to the PAM system and modules under FreeBSD
> trademarks: ["pam", "freebsd", "linux", "opengroup", "sun", "general"]
> ---
>
> diff --git a/documentation/content/en/articles/problem-reports/_index.adoc b/documentation/content/en/articles/problem-reports/_index.adoc
> index d61055bdfc..ac334b78b4 100644
> --- a/documentation/content/en/articles/problem-reports/_index.adoc
> +++ b/documentation/content/en/articles/problem-reports/_index.adoc
> @@ -3,7 +3,7 @@ title: Writing FreeBSD Problem Reports
> authors:
> - author: Dag-Erling Smørgrav
> - author: Mark Linimon
> -description: Writing FreeBSD Problem Reports
> +description: How to best formulate and submit a problem report to the FreeBSD Project
> trademarks: ["freebsd", "ibm", "intel", "sun", "general"]
> ---
>
> diff --git a/documentation/content/en/articles/rc-scripting/_index.adoc b/documentation/content/en/articles/rc-scripting/_index.adoc
> index 72e71bffbd..50507c8412 100644
> --- a/documentation/content/en/articles/rc-scripting/_index.adoc
> +++ b/documentation/content/en/articles/rc-scripting/_index.adoc
> @@ -4,7 +4,7 @@ authors:
> - author: Yar Tikhiy
> email: yar at FreeBSD.org
> copyright: 2005-2006, 2012 The FreeBSD Project
> -description: Practical rc.d scripting in BSD
> +description: A guide to writing new rc.d scripts and understanding those already written
> trademarks: ["freebsd", "netbsd", "general"]
> ---
>
> diff --git a/documentation/content/en/articles/releng/_index.adoc b/documentation/content/en/articles/releng/_index.adoc
> index 665c3cea45..ef1c6c5035 100644
> --- a/documentation/content/en/articles/releng/_index.adoc
> +++ b/documentation/content/en/articles/releng/_index.adoc
> @@ -1,10 +1,10 @@
> ---
> -title: FreeBSD Release Engineering
> +title: Legacy FreeBSD Release Engineering
> authors:
> - author: Murray Stokely
> email: murray at FreeBSD.org
> webpage: https://people.FreeBSD.org/~murray/
> -description: This paper describes the approach used by the FreeBSD release engineering team to make production quality releases of the FreeBSD Operating System
> +description: This paper describes the approach used by past the FreeBSD release engineering team to make production quality releases of the FreeBSD Operating System
> trademarks: ["freebsd", "intel", "general"]
> ---
>
> diff --git a/documentation/content/en/articles/remote-install/_index.adoc b/documentation/content/en/articles/remote-install/_index.adoc
> index e5343b75a9..03d62cad6a 100644
> --- a/documentation/content/en/articles/remote-install/_index.adoc
> +++ b/documentation/content/en/articles/remote-install/_index.adoc
> @@ -4,7 +4,7 @@ authors:
> - author: Daniel Gerzo
> email: danger at FreeBSD.org
> copyright: 2008-2021 The FreeBSD Documentation Project
> -description: Remote Installation of the FreeBSD Operating System Without a Remote Console
> +description: Describes the remote installation of the FreeBSD operating system when the console of the remote system is unavailable
> trademarks: ["freebsd", "general"]
> ---
>
> diff --git a/documentation/content/en/articles/serial-uart/_index.adoc b/documentation/content/en/articles/serial-uart/_index.adoc
> index 9bd53781e0..4a9d5b783f 100644
> --- a/documentation/content/en/articles/serial-uart/_index.adoc
> +++ b/documentation/content/en/articles/serial-uart/_index.adoc
> @@ -3,7 +3,7 @@ title: Serial and UART Tutorial
> authors:
> - author: Frank Durda
> email: uhclem at FreeBSD.org
> -description: How to use serial hardware and UART with FreeBSD
> +description: Detailed information about the use of serial ports and UART with FreeBSD
> trademarks: ["freebsd", "microsoft", "general"]
> ---
>
> diff --git a/documentation/content/en/articles/solid-state/_index.adoc b/documentation/content/en/articles/solid-state/_index.adoc
> index 4a1b022fdb..7238aa8dad 100644
> --- a/documentation/content/en/articles/solid-state/_index.adoc
> +++ b/documentation/content/en/articles/solid-state/_index.adoc
> @@ -4,7 +4,7 @@ authors:
> - author: John Kozubik
> email: john at kozubik.com
> copyright: 2001 - 2021 The FreeBSD Documentation Project
> -description: FreeBSD and Solid State Devices
> +description: The use of solid state disk devices in FreeBSD
> trademarks: ["freebsd", "general"]
> ---
>
> diff --git a/documentation/content/en/articles/vm-design/_index.adoc b/documentation/content/en/articles/vm-design/_index.adoc
> index 12a60f6962..884e88bd76 100644
> --- a/documentation/content/en/articles/vm-design/_index.adoc
> +++ b/documentation/content/en/articles/vm-design/_index.adoc
> @@ -3,7 +3,7 @@ title: Design elements of the FreeBSD VM system
> authors:
> - author: Matthew Dillon
> email: dillon at apollo.backplane.com
> -description: Design elements of the FreeBSD VM system
> +description: An easy to follow description of the design of the FreeBSD virtual memory system
> trademarks: ["freebsd", "linux", "microsoft", "opengroup", "daemon-news", "general"]
> ---
>
> diff --git a/documentation/content/en/books/arch-handbook/_index.adoc b/documentation/content/en/books/arch-handbook/_index.adoc
> index a5cefc4616..59041a32d6 100644
> --- a/documentation/content/en/books/arch-handbook/_index.adoc
> +++ b/documentation/content/en/books/arch-handbook/_index.adoc
> @@ -3,9 +3,10 @@ title: FreeBSD Architecture Handbook
> authors:
> - author: The FreeBSD Documentation Project
> copyright: Copyright © 2000-2006, 2012-2021 The FreeBSD Documentation Project
> -description: FreeBSD Architecture Handbook Index
> +description: For FreeBSD system developers. This book covers the architectural details of many important FreeBSD kernel subsystems
> trademarks: ["freebsd", "apple", "microsoft", "unix", "general"]
> next: books/arch-handbook/parti
> +weight: 50
> ---
>
> = FreeBSD Architecture Handbook
> diff --git a/documentation/content/en/books/design-44bsd/_index.adoc b/documentation/content/en/books/design-44bsd/_index.adoc
> index bab937e2fc..596a138529 100644
> --- a/documentation/content/en/books/design-44bsd/_index.adoc
> +++ b/documentation/content/en/books/design-44bsd/_index.adoc
> @@ -6,8 +6,9 @@ authors:
> - author: Michael J. Karels
> - author: John S. Quarterman
> copyright: 1996 Addison-Wesley Longman, Inc
> -description: The Design and Implementation of the 4.4BSD Operating System. Second chapter.
> +description: Donated by Addison-Wesley, provides a design overview of 4.4BSD, from which FreeBSD was originally derived
> trademarks: ["design-44bsd"]
> +weight: 60
> ---
>
> = The Design and Implementation of the 4.4BSD Operating System
> diff --git a/documentation/content/en/books/dev-model/_index.adoc b/documentation/content/en/books/dev-model/_index.adoc
> index c5b4061159..8d3b9ed4db 100644
> --- a/documentation/content/en/books/dev-model/_index.adoc
> +++ b/documentation/content/en/books/dev-model/_index.adoc
> @@ -3,8 +3,9 @@ title: A project model for the FreeBSD Project
> authors:
> - author: Niklas Saers
> copyright: Copyright © 2002-2005 Niklas Saers
> -description: A project model for the FreeBSD Project
> +description: A formal study of the organization of the FreeBSD project
> trademarks: ["freebsd", "ibm", "ieee", "adobe", "intel", "linux", "microsoft", "opengroup", "sun", "netbsd", "general"]
> +weight: 45
> ---
>
> = A project model for the FreeBSD Project
> diff --git a/documentation/content/en/books/developers-handbook/_index.adoc b/documentation/content/en/books/developers-handbook/_index.adoc
> index c7407e78d1..30c5d158f8 100644
> --- a/documentation/content/en/books/developers-handbook/_index.adoc
> +++ b/documentation/content/en/books/developers-handbook/_index.adoc
> @@ -3,9 +3,10 @@ title: FreeBSD Developers' Handbook
> authors:
> - author: The FreeBSD Documentation Project
> copyright: 1995-2021 The FreeBSD Documentation Project
> -description: FreeBSD Developers' Handbook Index
> +description: For people who want to develop software for FreeBSD (and not just people who are developing FreeBSD itself)
> trademarks: ["freebsd", "apple", "ibm", "ieee", "intel", "linux", "microsoft", "opengroup", "sun", "general"]
> next: books/developers-handbook/parti
> +weight: 25
> ---
>
> = FreeBSD Developers' Handbook
> diff --git a/documentation/content/en/books/faq/_index.adoc b/documentation/content/en/books/faq/_index.adoc
> index cf3d7379df..70690a9837 100644
> --- a/documentation/content/en/books/faq/_index.adoc
> +++ b/documentation/content/en/books/faq/_index.adoc
> @@ -3,8 +3,9 @@ title: Frequently Asked Questions for FreeBSD 11.X, 12.X, and 13.X
> authors:
> - author: The FreeBSD Documentation Project
> copyright: 1995-2021 The FreeBSD Documentation Project
> -description: Frequently Asked Questions (FAQ) for FreeBSD 11.X, 12.X, and 13.X
> +description: Frequently Asked Questions, and answers, covering all aspects of FreeBSD
> trademarks: ["freebsd", "ibm", "ieee", "adobe", "intel", "linux", "microsoft", "opengroup", "sun", "netbsd", "general"]
> +weight: 5
> ---
>
> = Frequently Asked Questions for FreeBSD {rel2-relx} and {rel-relx}
> diff --git a/documentation/content/en/books/fdp-primer/_index.adoc b/documentation/content/en/books/fdp-primer/_index.adoc
> index 403e249f11..fb703561d5 100644
> --- a/documentation/content/en/books/fdp-primer/_index.adoc
> +++ b/documentation/content/en/books/fdp-primer/_index.adoc
> @@ -4,8 +4,9 @@ authors:
> - author: The FreeBSD Documentation Project
> copyright: 1998-2021 DocEng
> trademarks: ["general"]
> -description: FreeBSD Documentation Project Primer for New Contributors Index
> +description: Everything you need to know in order to start contributing to the FreeBSD Documentation Project
> next: books/fdp-primer/preface
> +weight: 10
> ---
>
> = FreeBSD Documentation Project Primer for New Contributors
> diff --git a/documentation/content/en/books/handbook/_index.adoc b/documentation/content/en/books/handbook/_index.adoc
> index 0fdd49727d..f1f246dd93 100644
> --- a/documentation/content/en/books/handbook/_index.adoc
> +++ b/documentation/content/en/books/handbook/_index.adoc
> @@ -3,9 +3,10 @@ title: FreeBSD Handbook
> authors:
> - author: The FreeBSD Documentation Project
> copyright: 1995-2021 The FreeBSD Documentation Project
> -description: FreeBSD Handbook Index
> +description: A constantly evolving, comprehensive resource for FreeBSD users
> trademarks: ["freebsd", "ibm", "ieee", "redhat", "3com", "adobe", "apple", "intel", "linux", "microsoft", "opengroup", "sun", "realnetworks", "oracle", "3ware", "arm", "adaptec", "google", "heidelberger", "intuit", "lsilogic", "themathworks", "thomson", "vmware", "wolframresearch", "xiph", "xfree86", "general"]
> next: books/handbook/preface
> +weight: 1
> ---
>
> = FreeBSD Handbook
> diff --git a/documentation/content/en/books/porters-handbook/_index.adoc b/documentation/content/en/books/porters-handbook/_index.adoc
> index 60a9df7f8a..a82db8f052 100644
> --- a/documentation/content/en/books/porters-handbook/_index.adoc
> +++ b/documentation/content/en/books/porters-handbook/_index.adoc
> @@ -3,9 +3,10 @@ title: FreeBSD Porter's Handbook
> authors:
> - author: The FreeBSD Documentation Project
> copyright: 2000-2021 The FreeBSD Documentation Project
> -description: FreeBSD Porter's Handbook Index
> +description: Essential reading if you plan on providing a port of a third party piece of software
> trademarks: ["freebsd", "sun", "unix", "general"]
> next: books/porters-handbook/porting-why
> +weight: 15
> ---
>
> = FreeBSD Porter's Handbook
> diff --git a/documentation/themes/beastie/layouts/index.html b/documentation/themes/beastie/layouts/index.html
> index 1ba57c710a..8b56f7c484 100644
> --- a/documentation/themes/beastie/layouts/index.html
> +++ b/documentation/themes/beastie/layouts/index.html
> @@ -30,11 +30,13 @@
> {{ end }}
>
> <ul>
> - {{ range sort $books "path" }}
> + {{ range sort $books "weight" "path" }}
> {{ if in .path "_index.adoc" }}
> {{ $bookPath := replaceRE "/_index.adoc" "" .path }}
> {{ $bookName := replaceRE "books/" "" $bookPath }}
> - <li><a href="{{ $bookPath }}">{{ .page.Title }}</a></li>
> + <li><a href="{{ $bookPath }}">{{ .page.Title }}</a>
> + <p>{{ .page.Params.description }}</p>
> + </li>
> {{ end }}
> {{ end }}
> </ul>
> @@ -50,11 +52,13 @@
> {{ end }}
>
> <ul>
> - {{ range sort $articles "path" }}
> + {{ range sort $articles "weight" "path" }}
> {{ if in .path "_index.adoc" }}
> {{ $articlePath := replaceRE "/_index.adoc" "" .path }}
> {{ $articleName := replaceRE "articles/" "" $articlePath }}
> - <li><a href="{{ $articlePath }}">{{ .page.Title }}</a></li>
> + <li><a href="{{ $articlePath }}">{{ .page.Title }}</a>
> + <p>{{ .page.Params.description }}</p>
> + </li>
> {{ end }}
> {{ end }}
> </ul>
Uo! Really nice! Thanks for that!
I'm preparing the tags too :)
More information about the dev-commits-doc-all
mailing list