[Bug 291202] fdp-primer overview misleadingly omits where website build output is stored

From: <bugzilla-noreply_at_freebsd.org>
Date: Tue, 25 Nov 2025 09:09:17 UTC
https://bugs.freebsd.org/bugzilla/show_bug.cgi?id=291202

            Bug ID: 291202
           Summary: fdp-primer overview misleadingly omits where website
                    build output is stored
           Product: Documentation
           Version: Latest
          Hardware: Any
                OS: Any
            Status: New
          Severity: Affects Only Me
          Priority: ---
         Component: Books & Articles
          Assignee: doc@FreeBSD.org
          Reporter: bigsneaky@duck.com

The fourth section of the FreeBSD Documentation Project Primer "Quick Start"
guide (part of the Overview chapter) discusses how to build both documentation
and website subdirectories:

https://github.com/freebsd/freebsd-doc/blob/main/documentation/content/en/books/fdp-primer/overview/_index.adoc

> Always build and review the changes before submitting them.
> Running make in the documentation or website subdirectories
> will generate the documentation in HTML format.
> % make
> To reduce compile time, only one language can be compiled:
> % make DOC_LANG=en
> The build output is stored in ~/doc/documentation/public/en/articles/
> and ~/doc/documentation/public/en/books/.

The final statement seems to suggest all the previously discussed output - from
both the documentation and website subdirectories - will be stored in the two
stated directories. But build output from the website subdirectory is stored in
~/doc/website/public, which is not mentioned anywhere in the Overview chapter.

-- 
You are receiving this mail because:
You are the assignee for the bug.