git: 4f481548a0 - main - release archetype: Sync readme with 13.3R

Go to: [ bottom of page ] [ top of archives ] [ this month ]
From: Colin Percival <cperciva_at_FreeBSD.org>
Date: Wed, 20 Mar 2024 00:52:15 UTC
The branch main has been updated by cperciva:

URL: https://cgit.FreeBSD.org/doc/commit/?id=4f481548a0341f06dbde25280360b05573d42cb1

commit 4f481548a0341f06dbde25280360b05573d42cb1
Author:     Colin Percival <cperciva@FreeBSD.org>
AuthorDate: 2024-03-18 00:27:33 +0000
Commit:     Colin Percival <cperciva@FreeBSD.org>
CommitDate: 2024-03-20 00:51:52 +0000

    release archetype: Sync readme with 13.3R
    
    A number of updates have been made over the release which didn't land in the
    release archetype.
---
 website/archetypes/release/readme.adoc | 123 +++++++++++----------------------
 1 file changed, 39 insertions(+), 84 deletions(-)

diff --git a/website/archetypes/release/readme.adoc b/website/archetypes/release/readme.adoc
index 8a64b0e689..e252b367e1 100644
--- a/website/archetypes/release/readme.adoc
+++ b/website/archetypes/release/readme.adoc
@@ -36,8 +36,8 @@ This distribution is a {releaseType} of FreeBSD {releaseCurrent}, the latest poi
 [[about]]
 == About FreeBSD
 
-FreeBSD is an operating system based on 4.4 BSD Lite for AMD64 and Intel EM64T based PC hardware (amd64), Intel, AMD, Cyrix or NexGen x86 based PC hardware (i386), and UltraSPARC(R) machines (sparc64).
-Versions for the ARM(R) (arm), MIPS(R) (mips), and PowerPC(R) (powerpc) architectures are currently under development as well. 
+FreeBSD is an open source operating system derived from 4.4 BSD Lite2 for 64-bit x86-based PC hardware (amd64), 32-bit x86-based PC hardware (i386), 64-bit Arm(R) ARMv8-A AArch64 systems (aarch64), 32-bit Arm(R) ARMv6/7 systems (armv6/7), PowerPC(R) systems (powerpc, powerpc64), and RISC-V (riscv64) systems.
+
 FreeBSD works with a wide variety of peripherals and configurations and can be used for everything from software development to games to Internet Service Provision.
 
 This release of FreeBSD contains everything you need to run such a system, including full source code for the kernel and all utilities in the base distribution.
@@ -46,60 +46,23 @@ With the source distribution installed, you can literally recompile the entire s
 A large collection of third-party ported software (the Ports Collection) is also provided to make it easy to obtain and install all your favorite traditional UNIX(R) utilities for FreeBSD.
 Each port consists of a set of scripts to retrieve, configure, build, and install a piece of software, with a single command.
 Over {numports} ports, from editors to programming languages to graphical applications, make FreeBSD a powerful and comprehensive operating environment that extends far beyond what's provided by many commercial versions of UNIX(R).
-Most ports are also available as pre-compiled packages, which can be quickly installed from the installation program.
+Most ports are also available as pre-compiled packages, which can be quickly installed via the {{< manpage "pkg" "8">}} utility.
 
 [[audience]]
 == Target Audience
 
-This {releaseType} is aimed primarily at early adopters and various other users who want to get involved with the ongoing development of FreeBSD.
-While the FreeBSD development team tries its best to ensure that each {releaseType} works as advertised, {releaseBranch} is very much a work-in-progress.
-
-The basic requirements for using this {releaseType} are technical proficiency with FreeBSD and an understanding of the ongoing development process of FreeBSD {releaseBranch} (as discussed on the {freebsd-current}).
-
-For those more interested in doing business with FreeBSD than in experimenting with new FreeBSD technology, formal releases (such as {releasePrevStable}) are frequently more appropriate.
-Releases undergo a period of testing and quality assurance to ensure high reliability and dependability.
-
-This {releaseType} is aimed primarily at early adopters and various other users who want to get involved with the ongoing development of FreeBSD.
-While the FreeBSD development team tries its best to ensure that each {releaseType} works as advertised, {releaseBranch} is very much a work-in-progress.
-
-The basic requirements for using this {releaseType} are technical proficiency with FreeBSD and an understanding of the ongoing development process of FreeBSD {releaseBranch} (as discussed on the {freebsd-current}).
-
-For those more interested in doing business with FreeBSD than in experimenting with new FreeBSD technology, formal releases (such as {releasePrevStable}) are frequently more appropriate.
-Releases undergo a period of testing and quality assurance checking to ensure high reliability and dependability.
-
 This {releaseType} of FreeBSD is suitable for all users.
-It has undergone a period of testing and quality assurance checking to ensure the highest reliability and dependability.
+It has undergone a period of testing and quality assurance to ensure the highest reliability and dependability.
 
 [[obtain]]
 == Obtaining FreeBSD
 
-FreeBSD may be obtained in a variety of ways. 
-This section focuses on those ways that are primarily useful for obtaining a complete FreeBSD distribution, rather than updating an existing installation.
-
-[[cdromdvd]]
-=== CDROM and DVD
-
-FreeBSD -RELEASE distributions may be ordered on CDROM or DVD from several publishers.
-This is frequently the most convenient way to obtain FreeBSD for new installations, as it provides a convenient way to quickly reinstall the system if necessary.
-Some distributions include some of the optional, precompiled packages from the FreeBSD Ports Collection, or other extra material.
-
-A list of the CDROM and DVD publishers known to the project are listed in the link:{handbook}#mirrors[Obtaining FreeBSD] appendix to the Handbook.
-
-[[ftp]]
-=== FTP
-
-You can use FTP to retrieve FreeBSD and any or all of its optional packages from `ftp://ftp.FreeBSD.org/`, which is the official FreeBSD release site, or any of its mirrors.
-
-Lists of locations that mirror FreeBSD can be found in the link:{handbook}#mirrors-ftp[FTP Sites] section of the Handbook.
-Finding a close (in networking terms) mirror from which to download the distribution is highly recommended.
-
-Additional mirror sites are always welcome.
-Contact `<freebsd-admin@FreeBSD.org>` for more details on becoming an official mirror site.
-You can also find useful information for mirror sites at the link:{hubs}[Mirroring FreeBSD] article.
-
-Mirrors generally contain the ISO images generally used to create a CDROM of a FreeBSD release.
-They usually also contain floppy disk images (for applicable platforms), as well as the files necessary to do an installation over the network.
-Finally mirrors sites usually contain a set of packages for the most current release.
+FreeBSD may be obtained in a variety of ways.
+The most convenient way is to download a release image.
+Links to images for recent releases can be found on the FreeBSD Web site
+link:../../../where/[download page].
+This page includes information about the different types of images available
+as well as other ways to obtain a copy of FreeBSD.
 
 [[contacting]]
 == Contacting the FreeBSD Project
@@ -107,38 +70,30 @@ Finally mirrors sites usually contain a set of packages for the most current rel
 [[emailmailinglists]]
 === Email and Mailing Lists
 
-For any questions or general technical support issues, please send mail to the {freebsd-questions}.
+For general questions or technical support, please address the {freebsd-questions}.
 
-If you're tracking the {releaseBranch} development efforts, you must join the {freebsd-current}, in order to keep abreast of recent developments and changes that may affect the way you use and maintain the system.
+If you track the `{releaseBranch}` branch: you must subscribe to the {freebsd-stable}, to keep abreast of developments and changes that may affect your use and maintainance of the system.
 
-Being a largely-volunteer effort, the FreeBSD Project is always happy to have extra hands willing to help-there are already far more desired enhancements than there is time to implement them.
-To contact the developers on technical matters, or with offers of help, please send mail to the {freebsd-hackers}.
+Being a largely volunteer effort, the Project is always happy to have extra hands willing to help -- there are far more desired enhancements than there is time to implement them.
+To contact the developers on technical matters, or with offers of help, please address the {freebsd-hackers}.
 
-Please note that these mailing lists can experience significant amounts of traffic.
-If you have slow or expensive mail access, or are only interested in keeping up with major FreeBSD events, you may find it preferable to subscribe instead to the {freebsd-announce}.
+These lists above can experience significant amounts of traffic.
+If you have slow or expensive email access, or if you are only interested in major announcements, you may prefer subscription to the {freebsd-announce}.
 
-All of the mailing lists can be freely joined by anyone wishing to do so.
-Visit the link:https://lists.freebsd.org[FreeBSD Mailing Lists Page].
-This will give you more information on joining the various lists, accessing archives, etc.
-There are a number of mailing lists targeted at special interest groups not mentioned here; more information can be obtained either from the Mailman pages or the link:../../../support/#mailing-list[mailing lists section] of the FreeBSD Web site.
-
-[IMPORTANT]
-====
-Do not send email to the lists asking to be subscribed. Use the Mailman interface instead.
-====
+All public mailing lists can be joined by anyone wishing to do so.
+More than a hundred lists are public; https://lists.freebsd.org/[] shows them all, and provides information about browsing the archives, subscribing, and unsubscribing.
 
 [[pr]]
 === Submitting Problem Reports
 
-Suggestions, bug reports and contributions of code are always valued-please do not hesitate to report any problems you may find.
+Suggestions, bug reports and contributions of code are always valued.
+Please do not hesitate to report any problems you may find.
 Bug reports with attached fixes are of course even more welcome.
 
-The preferred method to submit bug reports from a machine with Internet connectivity is to use the Bugzilla bug tracker.
+The preferred method to submit bug reports from a machine with Internet connectivity is to use the link:https://bugs.freebsd.org[Bugzilla bug tracker].
 Problem Reports (PRs) submitted in this way will be filed and their progress tracked; the FreeBSD developers will do their best to respond to all reported bugs as soon as possible.
 link:https://bugs.freebsd.org/search/[A list of all active PRs] is available on the FreeBSD Web site; this list is useful to see what potential problems other users have encountered.
 
-Note that man:send-pr[1] is deprecated.
-
 For more information, link:{problem-reports}["Writing FreeBSD Problem Reports"], available on the FreeBSD Web site, has a number of helpful hints on writing and submitting effective problem reports.
 
 [[seealso]]
@@ -159,38 +114,38 @@ Some distributions may also include other formats such as Portable Document Form
 * [.filename]`HARDWARE.TXT`: The hardware compatibility list, showing devices with which FreeBSD has been tested and is known to work.
 * [.filename]`ERRATA.TXT`: Release errata. Late-breaking, post-release information can be found in this file, which is principally applicable to releases (as opposed to snapshots). It is important to consult this file before installing a release of FreeBSD, as it contains the latest information on problems which have been found and fixed since the release was created.
 
-On platforms that support man:bsdinstall[8] (currently amd64, i386, and sparc64), these documents are generally available via the Documentation menu during installation.
-Once the system is installed, you can revisit this menu by re-running the man:bsdinstall[8] utility.
+During installation, these documents are available via the Documentation menu.
+Once the system is installed, you can revisit this menu by re-running the {{< manpage "bsdinstall" "8">}} utility.
 
-[NOTE]
-====
-It is extremely important to read the errata for any given release before installing it, to learn about any late-breaking news or post-release problems.
+[.note]
+*Note*: +
+To learn about any late-breaking news or post-release problems, it is extremely important to read the errata for any given release before installing it.
 The errata file accompanying each release (most likely right next to this file) is already out of date by definition, but other copies are kept updated on the Internet and should be consulted as the current errata for this release.
 These other copies of the errata are located at link:../../releases/[https://www.FreeBSD.org/releases] (as well as any sites which keep up-to-date mirrors of this location).
-====
 
 [[manpages]]
 === Manual Pages
 
-As with almost all UNIX(R) like operating systems, FreeBSD comes with a set of on-line manual pages, accessed through the man:man[1] command or through the http://link:www.freebsd.org/cgi/man.cgi[hypertext manual pages gateway] on the FreeBSD Web site.
-In general, the manual pages provide information on the different commands and APIs available to the FreeBSD user.
+As with almost all UNIX(R)-like operating systems, FreeBSD includes a set of manual pages, accessible link:{manual-site}[online] or with the {{< manpage "man" "1">}} command.
 
-In some cases, manual pages are written to give information on particular topics.
-Notable examples of such manual pages are man:tuning[7] (a guide to performance tuning), man:security[7] (an introduction to FreeBSD security), and man:style[9] (a style guide to kernel coding).
+In general, these pages provide information on the different commands and APIs available to the FreeBSD user.
+
+Some pages are written to give information on particular topics.
+Notable examples include {{< manpage "tuning" "7">}} (a guide to performance tuning), {{< manpage "security" "7">}} (an introduction to FreeBSD security), and {{< manpage "style" "9">}} (a style guide for kernel coding).
 
 [[booksarticles]]
 === Books and Articles
 
-Two highly-useful collections of FreeBSD-related information, maintained by the FreeBSD Project, are the FreeBSD Handbook and FreeBSD FAQ(Frequently Asked Questions document).
-On-line versions of the link:{handbook}[Handbook] and link:{faq}[FAQ] are always available from the link:https://docs.FreeBSD.org[FreeBSD Documentation page] or its mirrors.
-If you install the [.filename]`doc` distribution set, you can use a Web browser to read the Handbook and FAQ locally.
-In particular, note that the Handbook contains a step-by-step guide to installing FreeBSD.
+FreeBSD Project-maintained documentation includes the highly useful _FreeBSD Handbook_, which includes a detailed guide to installing and upgrading the operating system, and _FreeBSD FAQ_ (Frequently Asked Questions).
+The link:{handbook}[Handbook] and link:{faq}[FAQ] are online in the link:{main-site}[documentation portal] and at mirror sites.
+
+Other Project-maintained books and articles are more specialized -- covering a wide range of topics, from effective use of the mailing lists, to dual-booting FreeBSD with other operating systems, to guidelines for new committers.
+Like the Handbook and FAQ, these documents are in the portal, mirrors and [.filename]`doc` repository.
 
-A number of on-line books and articles, also maintained by the FreeBSD Project, cover more-specialized, FreeBSD-related topics.
-This material spans a wide range of topics, from effective use of the mailing lists, to dual-booting FreeBSD with other operating systems, to guidelines for new committers.
-Like the Handbook and FAQ, these documents are available from the FreeBSD Documentation Page or in the doc distribution set.
+For offline documentation in HTML and PDF formats: you can install a language-specific package such as package:misc/freebsd-doc-en[] (_-en_ for English), or multi-language package:misc/freebsd-doc-all[].
+Alternatively, use a copy of the [.filename]`doc` repo to build and install from source code.
 
-A listing of other books and documents about FreeBSD can be found in the link:{handbook}#bibliography[bibliography]of the FreeBSD Handbook.
+A listing of other books and documents about FreeBSD can be found in the link:{handbook}bibliography[bibliography] of the FreeBSD Handbook.
 Because of FreeBSD's strong UNIX(R) heritage, many other articles and books written for UNIX(R) systems are applicable as well, some of which are also listed in the bibliography.
 
 [[acknowledgements]]