Bug 263571

Summary: FAQ: CURRENT, STABLE RELEASE: corrections, updates and enhancement
Product: Documentation Reporter: Graham Perrin <grahamperrin>
Component: Books & ArticlesAssignee: Sergio Carlavilla Delgado <carlavilla>
Status: Closed FIXED    
Severity: Affects Many People CC: carlavilla, doc, fernape, koobs, pauamma
Priority: ---    
Version: Latest   
Hardware: Any   
OS: Any   
URL: https://github.com/freebsd/freebsd-doc/blob/main/documentation/content/en/books/faq/_index.adoc#19-what-is-the-freebsd-stable-concept
See Also: https://bugs.freebsd.org/bugzilla/show_bug.cgi?id=259342
https://bugs.freebsd.org/bugzilla/show_bug.cgi?id=263315
https://bugs.freebsd.org/bugzilla/show_bug.cgi?id=263333
https://bugs.freebsd.org/bugzilla/show_bug.cgi?id=261816

Description Graham Perrin freebsd_committer freebsd_triage 2022-04-25 22:33:59 UTC
<https://docs.freebsd.org/en/books/faq/#stable>


Second paragraph, the first link refers to part of an article that is explicitly _legacy_: 

<https://docs.freebsd.org/en/articles/releng/#rel-branch>

Can we find an alternative that's not legacy?


Third of three paragraphs: 

* I doubt that 12.1 (twelve) is the latest RELEASE from 13-STABLE (thirteen)

* update, to no longer mention (or link to) end-of-life 11.3.


Consider using these two Kubilay Kocak graphics somewhere in the book of FAQ: 

    FreeBSD Development Lifecycle Overview (src)
    <https://i.imgur.com/rYdzTPw.png>

    FreeBSD Development Lifecycle (src)
    <https://i.imgur.com/wsaa55f.png>

koobs@ please, are originals available, in a format from which things other than PNG can be produced? (Subject to copyright, <https://creativecommons.org/licenses/by-nc-sa/4.0/>.)
Comment 1 Pau Amma 2022-04-27 02:20:18 UTC
Mostly same as https://bugs.freebsd.org/bugzilla/show_bug.cgi?id=261816 but some is missing in both, so not sure which to close as duplicate.
Comment 2 Kubilay Kocak freebsd_committer freebsd_triage 2022-04-27 02:23:38 UTC
(In reply to PauAmma from comment #1)

Close the 'less complete issue' duplicate of the first. If that tie cant be broken, default to closing the later (id) bug duplicate of the earlier.

@Graham I have original VSD's, and I believe it can export into other scalable formats (svg perhaps)
Comment 3 Kubilay Kocak freebsd_committer freebsd_triage 2022-04-27 02:24:52 UTC
(In reply to Kubilay Kocak from comment #2)

When closing in favour of earlier or another subsuming issue, make requests (or do it yourself) for any missing content (attachments, etc) to be added to the other issue
Comment 4 Graham Perrin freebsd_committer freebsd_triage 2022-05-29 11:44:16 UTC
Thank you both. 

(In reply to PauAmma from comment #1)

<https://reviews.freebsd.org/D35345#801307> and <https://reviews.freebsd.org/D35345#801313> some suggestions, partly overlapping with this bug 263571. 

If contentious, or misplaced in D35345: we can look towards a separate review.
Comment 5 Pau Amma 2022-05-29 23:33:54 UTC
(In reply to Graham Perrin from comment #4)

Separate is better, I think. I have other FAQ changes planned anyway.
Comment 6 Graham Perrin freebsd_committer freebsd_triage 2022-07-24 01:10:03 UTC
<https://docs.freebsd.org/en/books/faq/#stable>

> What is the FreeBSD-STABLE concept?

The question is not entirely answered. It seems to omit the essence: 

    application binary interface (ABI) stability.

From <http://www.wonkity.com/~wblock/docs/html/stable.html#_that_word_does_not_mean_what_you_think_it_means>: 

>> The name "-STABLE" is frequently misunderstood. It does not mean 
>> solid or steady. -STABLE means that while code can change, the 
>> ABI (Application Binary Interface) will remain stable and not change. 
>> Programs compiled to run on FreeBSD 10.0-RELEASE, or 10.1-RELEASE, 
>> or 10.2-RELEASE will continue to work on FreeBSD 10-STABLE. 
>> Effectively, -STABLE is the latest version of FreeBSD you can get 
>> without breaking installed software.
Comment 7 Fernando ApesteguĂ­a freebsd_committer freebsd_triage 2022-10-09 16:12:40 UTC
^Triage: reporter is committer, assign accordingly.
Comment 8 Fernando ApesteguĂ­a freebsd_committer freebsd_triage 2023-08-21 06:25:36 UTC
^Triage: Reporter is committer, assign accordingly

Any committer may commit to any repository with an accepted review from any committer with existing access to that repository.

Committers may obtain review via a Differential in Phabricator, adding the "Contributor Reviewers ($Repository)" group as a Reviewer, reaching out to other committers; directly or via mailing lists, or setting the attachment flag to: maintainer-approval ? <person-youd-like-to-review>
Comment 9 commit-hook freebsd_committer freebsd_triage 2023-10-11 19:24:12 UTC
A commit in branch main references this bug:

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

commit 5ab16dfdedb053e126d7d175c6d3b94aa2bca286
Author:     Sergio Carlavilla Delgado <carlavilla@FreeBSD.org>
AuthorDate: 2023-10-11 18:42:03 +0000
Commit:     Sergio Carlavilla Delgado <carlavilla@FreeBSD.org>
CommitDate: 2023-10-11 19:23:16 +0000

    FAQ: Complete FAQ rewrite

    Complete rewrite of the FAQ is being carried out to offer a version
    agnostic to the FreeBSD version and some simple entries.

    The idea behind this rewrite has been to simplify the FAQ and make it
    more accessible.

    The FAQ is an entry point to FreeBSD, for more complete questions we
    have the Handbook.

    PR:                     266111, 263571, 273313, 273313, 261765, 248351, 261816
    Reviewed by:            acm@, ashish@, cc@, emaste, fernape@, linimon@
    Differential Revision:  https://reviews.freebsd.org/D41644
    Sponsored by:           Daifressh

 documentation/content/en/books/faq/_index.adoc | 3292 +++---------------------
 1 file changed, 337 insertions(+), 2955 deletions(-)