git: 44bb3f68fb - main - books/fdp-primer: Update tools and add advanced build examples

[Danilo G. Baio]

The branch main has been updated by dbaio:

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

commit 44bb3f68fbe8aeef7ccbc3dc838ed11d4f53b067
Author:     Danilo G. Baio <dbaio at FreeBSD.org>
AuthorDate: 2021-06-16 23:45:46 +0000
Commit:     Danilo G. Baio <dbaio at FreeBSD.org>
CommitDate: 2021-06-16 23:54:21 +0000

    books/fdp-primer: Update tools and add advanced build examples
    
    This updates the documentation to reflect the changes that were made
    recently.
    
    Reviewed by:    ceri
    Differential Revision:  https://reviews.freebsd.org/D30749
---
 .../en/books/fdp-primer/doc-build/_index.adoc      | 39 ++++++++++++++++++++++
 .../en/books/fdp-primer/overview/_index.adoc       | 11 ++----
 .../content/en/books/fdp-primer/tools/_index.adoc  |  2 +-
 3 files changed, 42 insertions(+), 10 deletions(-)

diff --git a/documentation/content/en/books/fdp-primer/doc-build/_index.adoc b/documentation/content/en/books/fdp-primer/doc-build/_index.adoc
index 146f32ad11..c39adf8a40 100644
--- a/documentation/content/en/books/fdp-primer/doc-build/_index.adoc
+++ b/documentation/content/en/books/fdp-primer/doc-build/_index.adoc
@@ -89,6 +89,45 @@ To render the documentation and the website to `html` use one of the following e
 ....
 ====
 
+Advanced build examples are given below:
+
+[[documentation-build-example-verbose]]
+.Build the documentation with verbose and debug messages
+[example]
+====
+[source,shell]
+....
+% cd ~/doc/documentation
+% make HUGO_ARGS="--verbose --debug --path-warnings"
+....
+====
+
+[[documentation-build-example-server]]
+.Build and serve the content with Hugo’s internal webserver
+[example]
+====
+[source,shell]
+....
+% cd ~/doc/documentation
+% make run
+....
+This webserver runs on `localhost`, port `1313` by default.
+
+To serve the content with Hugo’s internal webserver binding a specific IP address:
+
+[source,shell]
+....
+% make run BIND=192.168.15.10
+....
+
+A `hostname` can also be set as base url to Hugo’s internal webserver:
+
+[source,shell]
+....
+% make run BIND=192.168.15.10 HOSTNAME=example.com
+....
+====
+
 [[doc-build-rendering-pdf]]
 === Rendering to pdf
 
diff --git a/documentation/content/en/books/fdp-primer/overview/_index.adoc b/documentation/content/en/books/fdp-primer/overview/_index.adoc
index 2fef4f9b53..fcea50e851 100644
--- a/documentation/content/en/books/fdp-primer/overview/_index.adoc
+++ b/documentation/content/en/books/fdp-primer/overview/_index.adoc
@@ -50,18 +50,11 @@ These people can help with questions or problems involving the documentation.
 
 [.procedure]
 ====
-. Install these packages. These packages are all of the software needed to edit and build FreeBSD documentation. The Git package is needed to obtain a working copy of the documentation and generate patches with.
+. Install these packages. The `docproj` _meta-port_ installs all the applications required to do useful work with the FreeBSD documentation.
 +
 [source,shell]
 ....
-# pkg install gohugo python3 git-lite rubygem-asciidoctor rubygem-rouge
-....
-+
-. Optional: to generate PDF documentation install `asciidoctor-pdf`
-+
-[source,shell]
-....
-# pkg install rubygem-asciidoctor-pdf 
+# pkg install docproj python3
 ....
 +
 . Install a local working copy of the documentation from the FreeBSD repository in [.filename]#~/doc# (see crossref:working-copy[working-copy,The Working Copy]).
diff --git a/documentation/content/en/books/fdp-primer/tools/_index.adoc b/documentation/content/en/books/fdp-primer/tools/_index.adoc
index 459ce9aa5b..a5acaf0859 100644
--- a/documentation/content/en/books/fdp-primer/tools/_index.adoc
+++ b/documentation/content/en/books/fdp-primer/tools/_index.adoc
@@ -31,7 +31,7 @@ Some are optional, adding capabilities or making the job of creating documentati
 [[tools-required]]
 == Required Tools
 
-Install `gohugo` and `rubygem-asciidoctor` as shown in crossref:overview[overview,the overview chapter] from the Ports Collection.
+Install `docproj` and `python3` as shown in crossref:overview[overview,the overview chapter] from the Ports Collection.
 These applications are required to do useful work with the FreeBSD documentation.
 Some further notes on particular components are given below.