Bug 259342 - FAQ: links to the handbook are broken
Summary: FAQ: links to the handbook are broken
Status: Closed FIXED
Alias: None
Product: Documentation
Classification: Unclassified
Component: Books & Articles (show other bugs)
Version: Latest
Hardware: Any Any
: --- Affects Only Me
Assignee: Sergio Carlavilla Delgado
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2021-10-21 14:11 UTC by Mitchell Horne
Modified: 2022-09-04 10:33 UTC (History)
2 users (show)

See Also:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Mitchell Horne freebsd_committer freebsd_triage 2021-10-21 14:11:32 UTC
The FAQ contains several links to specific Handbook chapters, but these don't point to the right place, and the user is instead redirected to the Handbook's front page. I assume this is fallout from the recent doc transition.

For example, section 3.4 of the FAQ contains the following link:
https://docs.freebsd.org/en/books/handbook/#bsdinstall/

But this chapter is really located at:
https://docs.freebsd.org/en/books/handbook/bsdinstall/

Section 12.6 links to a section:
https://docs.freebsd.org/en/books/handbook/#configuring-nfs

But this should be:
https://docs.freebsd.org/en/books/handbook/network-servers/#network-configuring-nfs


... and more like this. Someone will need to make a pass at this document and evaluate where each link is intended to point.
Comment 1 Sergio Carlavilla Delgado freebsd_committer freebsd_triage 2021-10-23 11:25:50 UTC
It's fixed in this review: https://reviews.freebsd.org/D31926
Comment 2 Graham Perrin freebsd_committer freebsd_triage 2022-04-24 09:03:06 UTC
> How can I correct the keyboard mappings for my system?

The single-sentence paragraph under <https://github.com/freebsd/freebsd-doc/blob/main/documentation/content/en/books/faq/_index.adoc#107-how-can-i-correct-the-keyboard-mappings-for-my-system> | <https://docs.freebsd.org/en/books/faq/#keyboard-mappings>: 

> Refer to the Handbook section on using localization, specifically the 
> section on console setup.

– both links are broken: 

    <https://docs.freebsd.org/en/books/handbook/#using-localization>

    <https://docs.freebsd.org/en/books/handbook/#setting-console>

Instead: 

    <https://docs.freebsd.org/en/books/handbook/l10n/>
    <https://docs.freebsd.org/en/books/handbook/book/#l10n>

    <https://docs.freebsd.org/en/books/handbook/l10n/#setting-console>
    <https://docs.freebsd.org/en/books/handbook/book/#setting-console>

– where 'Localization - i18n/L10n Usage and Setup' is the title of the _chapter_ (not a section within a chapter).

Consider rewording the paragraph: 

> See the Console Setup section of Localization - i18n/L10n Usage and Setup, 
> kbdmap(1) in particular. 

(The Handbook is misleading, I'll raise a separate bug for this.)

----

See also: bug 260199, bug 263320 (likely overlap with FAQ).
Comment 3 Mitchell Horne freebsd_committer freebsd_triage 2022-09-01 14:59:47 UTC
(In reply to Sergio Carlavilla Delgado from comment #1)

Hi Sergio,

The linked review was marked as Closed, but I cannot tell if the change was committed. Can you comment on the status here?

As of today the mentioned links in the FAQ are still broken.
Comment 4 Sergio Carlavilla Delgado freebsd_committer freebsd_triage 2022-09-01 16:46:00 UTC
(In reply to Mitchell Horne from comment #3)
I'm gonna take a look.
Comment 5 commit-hook freebsd_committer freebsd_triage 2022-09-04 10:31:00 UTC
A commit in branch main references this bug:

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

commit d46632e1af2002089721a751d7655401f513fe43
Author:     Sergio Carlavilla Delgado <carlavilla@FreeBSD.org>
AuthorDate: 2022-09-04 10:29:12 +0000
Commit:     Sergio Carlavilla Delgado <carlavilla@FreeBSD.org>
CommitDate: 2022-09-04 10:30:29 +0000

    Fix links to the handbook in FAQ

    PR:             259342, 266107
    Submitted by:   grahamperrin@, mhorne@

 documentation/content/en/books/faq/_index.adoc | 76 +++++++++++++-------------
 1 file changed, 38 insertions(+), 38 deletions(-)
Comment 6 Sergio Carlavilla Delgado freebsd_committer freebsd_triage 2022-09-04 10:33:49 UTC
Fixed.
I reviewed all the links.
There are three which I cannot link correctly to the handbook since the anchor was removed in the handbook.

Btw, I'm gonna start a rewrite of the FAQ in the EuroBSDCon