Bug 261811

Summary:	Improve Documentation :: Documentation component description
Product:	Services	Reporter:	Pau Amma <pauamma>
Component:	Bug Tracker	Assignee:	Bugmeister <bugmeister>
Status:	Closed FIXED
Severity:	Affects Some People	CC:	bugmeister, grahamperrin
Priority:	---
Version:	unspecified
Hardware:	Any
OS:	Any

Description Pau Amma 2022-02-09 05:32:37 UTC

That description currently reads "Handbook and FAQ" but:
- there are several handbooks
- there are books other than handbooks, including but not limited to the FAQ
- there are articles

Altogether, I'd change that description to "Books and articles" or something along these lines.

Comment 1 Pau Amma 2022-05-19 12:44:01 UTC

Having completely forgotten I opened this, I was about to open a duplicate. Anything I can/should do to help?

Comment 2 Kubilay Kocak freebsd_committer

2022-05-30 01:35:38 UTC

The Identical name of Documentation :: Documentation was always annoying, left as is, to be the 'capture all' component for issues that couldn't explicitly be classified to the other Documentation components. 

Alternative naming perhaps ought to have been more obvious given the description "Handbook and FAQ " set at the time.

Looking back now, and in-discussion with Reporter via IRC, we'll rename:

Component: Documentation -> Books & Articles, leaving room for further detail in the description, to capture 'handbook' and 'faq' specifically as examples.

Comment 3 Kubilay Kocak freebsd_committer

2022-05-30 01:37:28 UTC

Name updated to: 'Books & Articles'
Description updated to: 'Handbooks, Primers, Guides, FAQ's and other specific reference documentation.'


Thanks for the report and nudges!