doc/website/content/en/relnotes.adoc
Sergio Carlavilla Delgado 989d921f5d Migrate doc to Hugo/AsciiDoctor
I'm very pleased to announce the release of
our new website and documentation using
the new toolchain with Hugo and AsciiDoctor.

To get more information about the new toolchain
please read the FreeBSD Documentation Project Primer[1],
Hugo docs[2] and AsciiDoctor docs[3].

Acknowledgment:
Benedict Reuschling <bcr@>
Glen Barber <gjb@>
Hiroki Sato <hrs@>
Li-Wen Hsu <lwhsu@>
Sean Chittenden <seanc@>
The FreeBSD Foundation

[1] https://docs.FreeBSD.org/en/books/fdp-primer/
[2] https://gohugo.io/documentation/
[3] https://docs.asciidoctor.org/home/

Approved by:    doceng, core
2021-01-26 00:31:29 +01:00

55 lines
2.3 KiB
Text

---
title: "Release Documentation"
sidenav: about
---
include::shared/releases.adoc[]
= Release Documentation
[.right]
image:../gifs/doc.jpg[BSD daemon reading documentation,width=274,height=163]
Each distribution of FreeBSD includes several documentation files describing the particular distribution (RELEASE, SNAPSHOTs, etc.). These files typically include:
* README: General introduction.
* Release Notes: Information about changes from the previous release of FreeBSD.
* Hardware Notes: A list of hardware devices known to work with FreeBSD.
* Installation Instructions: A brief guide to installing FreeBSD.
* Errata: Late-breaking news, including corrections, security advisories, and potential problems found after each release.
The release notes, hardware notes, and installation instructions are customized for each architecture supported by FreeBSD.
== RELEASE versions of FreeBSD
The release documentation for each -RELEASE version of FreeBSD (for example, {rel120-current}-RELEASE) can be found on the link:..releases/[releases] page of the FreeBSD web site and on mirror sites.
These files are located in the top-level directory of each distribution. Both HTML and text forms are usually provided.
== Snapshot Versions of FreeBSD
The release documentation files for snapshots are generally in the top-level directory of each snapshot.
== Documentation for -CURRENT and -STABLE
HTML versions of the release documentation for FreeBSD -CURRENT and FreeBSD -STABLE are available on the FreeBSD web site. These documents are continually changing and automatically generated. The versions on the web site are rebuilt at the same time that the rest of the web site is updated.
=== FreeBSD -CURRENT Release Documentation
* link:../releases/12.0r/readme/[README]
* link:../releases/12.0r/relnotes/[Release Notes]
* link:../releases/12.0r/hardware/[Hardware Notes]
=== FreeBSD 11-STABLE Release Documentation
* link:../relnotes/11-STABLE/readme/[README]
* link:../relnotes/11-STABLE/relnotes/[Release Notes]
* link:../relnotes/11-STABLE/hardware/[Hardware Notes]
* link:../relnotes/11-STABLE/errata/[Errata]
=== FreeBSD 10-STABLE Release Documentation
* link:../relnotes/10-STABLE/readme/[README]
* link:../relnotes/10-STABLE/relnotes/[Release Notes]
* link:../relnotes/10-STABLE/hardware/[Hardware Notes]
* link:../relnotes/10-STABLE/errata/[Errata]