git: 5c8cc20333 - main - Download FreeBSD: headings, redundancy, clarity

From: Graham Perrin <grahamperrin_at_FreeBSD.org>
Date: Mon, 07 Nov 2022 15:24:21 UTC
The branch main has been updated by grahamperrin:

URL: https://cgit.FreeBSD.org/doc/commit/?id=5c8cc20333c4e87dd5d3a562ad87f5c18254d5fd

commit 5c8cc20333c4e87dd5d3a562ad87f5c18254d5fd
Author:     Graham Perrin <grahamperrin@FreeBSD.org>
AuthorDate: 2022-11-07 15:13:17 +0000
Commit:     Graham Perrin <grahamperrin@FreeBSD.org>
CommitDate: 2022-11-07 15:13:17 +0000

    Download FreeBSD: headings, redundancy, clarity
    
    https://www.freebsd.org/where/
    
    Level 1 heading 'Download FreeBSD' is not perceptibly different from
    the identically-worded visible title. This heading appears to be
    redundant.
    
    The very short 'Help to Test' section is no more than direction to
    visit the download page. Self-referencing.
    
    Generally, the page has become a slightly disorderly mix. Begin
    improving this, partly through adjustments to heading levels.
    
    Two new headings, level 1:
    
    Production Quality
    
    Development and Testing
    
    … and so on.
    
    Reviewed by:           pauamma
    Approved by:           gjb (mentor)
    Differential revision: https://reviews.freebsd.org/D37235
---
 website/content/en/where.adoc | 71 ++++++++++++++++++++++++++++---------------
 1 file changed, 46 insertions(+), 25 deletions(-)

diff --git a/website/content/en/where.adoc b/website/content/en/where.adoc
index 454cf03454..46e06bf5f5 100644
--- a/website/content/en/where.adoc
+++ b/website/content/en/where.adoc
@@ -11,11 +11,9 @@ include::shared/en/urls.adoc[]
 
 For general information about past, present and future releases, see link:../releases/[Release Information].
 
-= Download FreeBSD
-
 [[choose-version]]
 [[choose-arch]]
-== Choosing an Architecture
+= Choosing an Architecture
 
 Most users of FreeBSD will have hardware for **amd64** or **aarch64**. These architectures are well-supported.
 
@@ -26,7 +24,7 @@ Embedded devices and single-board computers (SBCs) such as the Raspberry Pi 3 an
 For all other architectures, please see the link:../platforms/#_supported_platforms[table of supported platforms].
 
 [[choose-image]]
-== Choosing an Image
+= Choosing an Image
 
 For the FreeBSD installer: formats include CD (disc1), DVD (dvd1), and network install (bootonly) sized ISO, plus regular and mini USB memory sticks.
 
@@ -35,6 +33,10 @@ For virtual machines: virtual disk images have FreeBSD preinstalled.
 For embedded platforms: SD card images are available.
 
 [[download]]
+= Production Quality
+
+`RELEASE` versions of FreeBSD are the end result of _release engineering_.
+
 [[download-rel131]]
 == FreeBSD {rel131-current}-RELEASE
 [.tblbasic]
@@ -139,9 +141,24 @@ a|
 |===
 
 [[helptest]]
-== Help to Test
+= Development and Testing
+
+Pre-`RELEASE` versions of FreeBSD, not intended for use in production environments:
+
+* `CURRENT` – the main branch, the core of development
+* `STABLE` – branched from `CURRENT`, long-term preparations for release engineering
+* release engineering – `ALPHA`, `BETA`, release candidates (`RC`) – branched from `STABLE`.
+
+Uppercase has special meaning. For example:
+
+* a first _beta release_ is not a (production) `RELEASE`.
+
+The word `CURRENT` is sometimes a source of confusion:
+
+* if you are looking for the _current version_ of FreeBSD, you most likely want a `RELEASE` version (see above) – **not** `CURRENT`
+
+– `CURRENT` has special meaning in the development process.
 
-If you are interested in testing the next upcoming release, please visit the link:../where/[FreeBSD download page].
 [[download-rel124]]
 == FreeBSD {rel124-current}-RC1
 
@@ -217,25 +234,38 @@ VM images are available for link:{url-snapshot}/VM-IMAGES/{rel123-current}-STABL
 ////
 
 [[install]]
-=== Install FreeBSD
+= Installation
+
+Options include:
+
+* images
+* direct download (anonymous FTP, and HTTPS).
 
-Options include images (see above) and direct download (anonymous FTP, HTTPS, and NFS).
 Before downloading an entire distribution, please read the link:{handbook}bsdinstall/[installation guide].
 
 If you plan to get FreeBSD via FTP or HTTPS, check the FreeBSD Handbook for link:{handbook}mirrors/#mirrors[suitable mirrors] for your region.
 
 [[distribution]]
-=== Purchase FreeBSD Media
+= Purchase FreeBSD Media
 
 FreeBSD can be acquired on CD-ROM or DVD from https://www.freebsdmall.com/[FreeBSD Mall], and other link:{handbook}mirrors/#mirrors-cdrom[CD-ROM and DVD publishers].
 
-[[past]]
-=== Past Releases
+[[apps]]
+= Applications and Utility Software
+
+== The Ports Collection
+
+A diverse collection of utility and application software that has been _ported_ to FreeBSD.
 
-Please browse the http://ftp-archive.FreeBSD.org/pub/FreeBSD-Archive/old-releases/[FTP archive].
+* link:../ports/[About FreeBSD Ports]
+* https://www.freshports.org/[FreshPorts - a more advanced web interface to the Collection]
+* link:{handbook}#ports[Installing Applications: Packages and Ports] in the FreeBSD Handbook
+* Browse the Collection: https://download.freebsd.org/ports/[web] | ftp://ftp.freebsd.org/pub/FreeBSD/ports/[FTP].
+
+For information about how _you_ can contribute _your_ favorite piece of software to the Collection, have a look at _link:{porters-handbook}[The Porter's Handbook]_ and _link:{contributing}[Contributing to FreeBSD]_.
 
 [[derived]]
-=== FreeBSD-derived Operating System Distributions
+= FreeBSD-derived Operating System Distributions
 
 FreeBSD is widely used as a building block for other commercial and open-source operating systems.
 The projects below are of particular interest.
@@ -246,16 +276,7 @@ The projects below are of particular interest.
 * https://www.nomadbsd.org[NomadBSD] is a persistent live system for USB flash drives, based on FreeBSD. Together with automatic hardware detection and setup, it is configured to be used as a desktop system that works out of the box, but can also be used for data recovery, for educational purposes, or to test FreeBSD hardware compatibility.
 * https://www.pfsense.org/[pfSense] is a FreeBSD-based customized distribution tailored for use as a firewall and router.
 
-[[apps]]
-=== Applications and Utility Software
-
-==== The Ports Collection
-
-A diverse collection of utility and application software that has been _ported_ to FreeBSD.
-
-* link:../ports/[About FreeBSD Ports]
-* https://www.freshports.org/[FreshPorts - a more advanced web interface to the Collection]
-* link:{handbook}#ports[Installing Applications: Packages and Ports] in the FreeBSD Handbook
-* Browse the Collection: https://download.freebsd.org/ports/[web] | ftp://ftp.freebsd.org/pub/FreeBSD/ports/[FTP].
+[[past]]
+= Archives
 
-For information about how _you_ can contribute _your_ favorite piece of software to the Collection, have a look at _link:{porters-handbook}[The Porter's Handbook]_ and _link:{contributing}[Contributing to FreeBSD]_.
+http://ftp-archive.FreeBSD.org/pub/FreeBSD-Archive/old-releases/[Past releases] of FreeBSD.