Bug 188031 - Contradictions between the FAQ and the Handbook
Summary: Contradictions between the FAQ and the Handbook
Status: Closed FIXED
Alias: None
Product: Documentation
Classification: Unclassified
Component: Books & Articles (show other bugs)
Version: Latest
Hardware: Any Any
: Normal Affects Only Me
Assignee: Rene Ladan
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2014-03-28 13:20 UTC by Kim Naim Lesmer
Modified: 2016-01-22 16:10 UTC (History)
1 user (show)

See Also:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Kim Naim Lesmer 2014-03-28 13:20:00 UTC
On the FAQ here: https://www.freebsd.org/doc/faq/introduction.html

It says, when explaining the different releases:

"Briefly, -STABLE is aimed at the ISP, corporate user, or any user who wants stability and a minimal number of changes compared to the new (and possibly unstable) features of the latest -CURRENT snapshot."

This is highly contradictory to the information provided several places in the Hanbook.

For example:

http://www.freebsd.org/doc/handbook/current-stable.html

"This is still a development branch and, at any given time, the sources for FreeBSD-STABLE may or may not be suitable for general use. It is simply another engineering development track, not a resource for end-users."

Fix: 

I think having a FAQ section outside of the Handbook is a problem. It would be better, easier to keep track of things, if the FAQ is moved to the Handbook and then the above information corrected.
Comment 1 Andrew.Moseman 2014-03-28 13:32:55 UTC
Good catch Kim,

Another suggestion would be to link the FAQ to the hand book or vice versa =
and manage only one definition.

-----Original Message-----
From: owner-freebsd-advocacy@freebsd.org [mailto:owner-freebsd-advocacy@fre=
ebsd.org] On Behalf Of Kim Lesmer
Sent: Friday, March 28, 2014 9:11 AM
To: freebsd-gnats-submit@FreeBSD.org
Subject: advocacy/188031: Contradictions between the FAQ and the Handbook


>Number:         188031
>Category:       advocacy
>Synopsis:       Contradictions between the FAQ and the Handbook
>Confidential:   no
>Severity:       non-critical
>Priority:       low
>Responsible:    freebsd-advocacy
>State:          open
>Quarter:       =20
>Keywords:      =20
>Date-Required:
>Class:          doc-bug
>Submitter-Id:   current-users
>Arrival-Date:   Fri Mar 28 13:20:00 UTC 2014
>Closed-Date:
>Last-Modified:
>Originator:     Kim Lesmer
>Release:        10
>Organization:
>Environment:
>Description:
On the FAQ here: https://www.freebsd.org/doc/faq/introduction.html

It says, when explaining the different releases:

"Briefly, -STABLE is aimed at the ISP, corporate user, or any user who want=
s stability and a minimal number of changes compared to the new (and possib=
ly unstable) features of the latest -CURRENT snapshot."

This is highly contradictory to the information provided several places in =
the Hanbook.

For example:

http://www.freebsd.org/doc/handbook/current-stable.html

"This is still a development branch and, at any given time, the sources for=
 FreeBSD-STABLE may or may not be suitable for general use. It is simply an=
other engineering development track, not a resource for end-users."


>How-To-Repeat:

>Fix:
I think having a FAQ section outside of the Handbook is a problem. It would=
 be better, easier to keep track of things, if the FAQ is moved to the Hand=
book and then the above information corrected.

>Release-Note:
>Audit-Trail:
>Unformatted:
_______________________________________________
freebsd-advocacy@freebsd.org mailing list http://lists.freebsd.org/mailman/=
listinfo/freebsd-advocacy
To unsubscribe, send any mail to "freebsd-advocacy-unsubscribe@freebsd.org"
Comment 2 Eitan Adler freebsd_committer freebsd_triage 2014-03-28 15:05:11 UTC
FWIW the handbook is correct: -stable is a development branch.

-- 
Eitan Adler
Comment 3 Rene Ladan freebsd_committer freebsd_triage 2016-01-10 20:32:13 UTC
It would be best in my opinion to change the FAQ, I will prepare a patch.
Comment 4 Rene Ladan freebsd_committer freebsd_triage 2016-01-10 21:25:49 UTC
I have modified section 1.7 and 1.9 of the FAQ to be more in line with the Handbook, the changes should appear online in a few hours.
Comment 5 commit-hook freebsd_committer freebsd_triage 2016-01-10 21:25:58 UTC
A commit references this bug:

Author: rene
Date: Sun Jan 10 21:25:03 UTC 2016
New revision: 47989
URL: https://svnweb.freebsd.org/changeset/doc/47989

Log:
  Synchronize the description of the intended audience of FreeBSD-STABLE with
  that of the Handbook.

  Trim section 1.7 somewhat. In section 1.9, notet that FreeBSD-STABLE is just
  another development branch and not specifically made for ISPs.

  PR:		188031
  Submitted by:	knl@bitflop.com

Changes:
  head/en_US.ISO8859-1/books/faq/book.xml
Comment 6 Kubilay Kocak freebsd_committer freebsd_triage 2016-01-22 16:10:46 UTC
Correctly classify