Bug 260007 - Refactor version list in user handbook intro (and other books as needed) for easier update
Summary: Refactor version list in user handbook intro (and other books as needed) for ...
Status: Closed FIXED
Alias: None
Product: Documentation
Classification: Unclassified
Component: Books & Articles (show other bugs)
Version: Latest
Hardware: Any Any
: --- Affects Some People
Assignee: Sergio Carlavilla Delgado
URL:
Keywords:
Depends on:
Blocks: handbook-2022
  Show dependency tree / graph
 
Reported: 2021-11-23 23:13 UTC by Pau Amma
Modified: 2022-04-23 08:20 UTC (History)
3 users (show)

See Also:

Attachments
Add an attachment (proposed patch, testcase, etc.)

Note You need to log in before you can comment on or make changes to this bug.
Description Pau Amma 2021-11-23 23:13:40 UTC 
It's currently duplicated in _index.adoc and book.adoc, which makes it all too easy to update only one. Ideally, it should be somewhere shared by all translations of all documents so they can all be updated in one stroke.

Based on an IRC discussion with emaste and AllanJude.
Comment 1 Pau Amma 2022-04-09 23:59:47 UTC 
Where should that list go and which other books and or articles should use it? (FAQ is a likely candidate.)
Comment 2 Sergio Carlavilla Delgado freebsd_committer freebsd_triage 2022-04-18 18:33:59 UTC 
Review: https://reviews.freebsd.org/D34946
Comment 3 commit-hook freebsd_committer freebsd_triage 2022-04-23 08:18:49 UTC 
A commit in branch main references this bug:

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

commit ada565b6d3166a95ec111c2f63f035060080600c
Author:     Sergio Carlavilla Delgado <carlavilla@FreeBSD.org>
AuthorDate: 2022-04-23 08:15:29 +0000
Commit:     Sergio Carlavilla Delgado <carlavilla@FreeBSD.org>
CommitDate: 2022-04-23 08:18:28 +0000

    Refactor version list in user handbook intro

    PR:                             260007
    Submitted by:                   Pau Amma (pauamma_gundo.com)
    Reviewed by:                    Pau Amma (pauamma_gundo.com)
    Approved by:                    debdrup@
    Differential Revision:          https://reviews.freebsd.org/D34946

 documentation/content/en/books/handbook/_index.adoc      | 16 ++++------------
 documentation/content/en/books/handbook/book.adoc        | 13 +------------
 .../content/en/books/handbook/introduction.adoc (new)    | 12 ++++++++++++
 3 files changed, 17 insertions(+), 24 deletions(-)
Comment 4 Sergio Carlavilla Delgado freebsd_committer freebsd_triage 2022-04-23 08:20:14 UTC 
Fixed. Thanks for the report.