Bug 274072 - FDP primer: quick start: fix misdirections
Summary: FDP primer: quick start: fix misdirections
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: https://github.com/freebsd/freebsd-do...
Keywords:
Depends on:
Blocks:
 
Reported: 2023-09-25 06:18 UTC by Graham Perrin
Modified: 2023-10-07 06:17 UTC (History)
2 users (show)

See Also:

Attachments
Example: /usr/doc/documentation/public/en exists (1.75 KB, text/plain)
2023-09-25 06:18 UTC, Graham Perrin 		no flags Details
View All 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 Graham Perrin 2023-09-25 06:18:05 UTC 
Created attachment 245207 [details]
Example: /usr/doc/documentation/public/en exists

<https://docs.freebsd.org/en/books/fdp-primer/book/#freebsd-installation-process> step 4 directs readers to two directories that do not exist: 

> … ~/documentation/public/articles/ and ~/documentation/public/books/.

For each of the two paths, two aspects are wrong. 

1) This does not exist:

    ~/documentation

2) Where a path does exist, 

    public/

    is followed by a locale-specific subdirectory.
Comment 1 commit-hook freebsd_committer freebsd_triage 2023-09-25 06:54:25 UTC 
A commit in branch main references this bug:

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

commit 0e60961e5a28024ef485514bf4e683b43795a02a
Author:     Sergio Carlavilla Delgado <carlavilla@FreeBSD.org>
AuthorDate: 2023-09-25 06:52:34 +0000
Commit:     Sergio Carlavilla Delgado <carlavilla@FreeBSD.org>
CommitDate: 2023-09-25 06:52:34 +0000

    FDP-overview: Fix build output path

    PR:             274072
    Submitted by:   Graham Perrin <grahamperring@gmail.com>

 documentation/content/en/books/fdp-primer/overview/_index.adoc | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Comment 2 Sergio Carlavilla Delgado freebsd_committer freebsd_triage 2023-09-25 06:54:42 UTC 
Done
Comment 3 Graham Perrin 2023-09-25 08:47:07 UTC 
In the summary line: 

> misdirection to non-existent ~/documentation

(In reply to commit-hook from comment #1)

<https://github.com/freebsd/freebsd-doc/commit/0e60961e5a28024ef485514bf4e683b43795a02a#diff-b84dd44f86b2b857e45c34fe1d19516bbf0c8d9df79a5f996881e25c236dc764L146-R146> uses the same, non-existent ~/documentation
Comment 4 commit-hook freebsd_committer freebsd_triage 2023-09-25 08:59:52 UTC 
A commit in branch main references this bug:

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

commit a3e71e854d225ecc626c3210fc115f96c3202f18
Author:     Sergio Carlavilla Delgado <carlavilla@FreeBSD.org>
AuthorDate: 2023-09-25 08:57:58 +0000
Commit:     Sergio Carlavilla Delgado <carlavilla@FreeBSD.org>
CommitDate: 2023-09-25 08:57:58 +0000

    FDP-Overview: Really fix the documentation path

    PR:             274072
    Submitted by:   Graham Perrin <grahamperrin@gmail.com>

 documentation/content/en/books/fdp-primer/overview/_index.adoc | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Comment 5 Graham Perrin 2023-10-07 02:44:23 UTC 
Please reassign to me.
Comment 6 commit-hook freebsd_committer freebsd_triage 2023-10-07 06:17:31 UTC 
A commit in branch main references this bug:

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

commit d73ac7f9a4c281364a75721ea7d26210f38d5188
Author:     Graham Perrin <grahamperrin@gmail.com>
AuthorDate: 2023-10-07 06:16:23 +0000
Commit:     Sergio Carlavilla Delgado <carlavilla@FreeBSD.org>
CommitDate: 2023-10-07 06:16:23 +0000

    FDP - Overview: Fix build path

    PR:                     274072
    Differential Revision:  https://reviews.freebsd.org/D42115

 documentation/content/en/books/fdp-primer/overview/_index.adoc | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Comment 7 Sergio Carlavilla Delgado freebsd_committer freebsd_triage 2023-10-07 06:17:54 UTC 
No, don't touch the "Assignee" field.