git: 815fb2e573 - main - Add instructions to build the documentation using GNU/Linux

The branch main has been updated by carlavilla:

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

commit 815fb2e573c0e6484c4e0622c216bb8c2895e307
Author:     Sergio Carlavilla Delgado <[email protected]>
AuthorDate: 2022-02-28 18:04:14 +0000
Commit:     Sergio Carlavilla Delgado <[email protected]>
CommitDate: 2022-02-28 18:04:14 +0000

    Add instructions to build the documentation using GNU/Linux
    
    Reviewd by:             debdrup@, Pau Amma <pauamma_gundo.com>
    Differential Revision:  https://reviews.freebsd.org/D34099
---
 .../en/books/fdp-primer/overview/_index.adoc       | 62 +++++++++++++++++++++-
 1 file changed, 61 insertions(+), 1 deletion(-)

diff --git a/documentation/content/en/books/fdp-primer/overview/_index.adoc b/documentation/content/en/books/fdp-primer/overview/_index.adoc
index 1daec39462..bc2905f462 100644
--- a/documentation/content/en/books/fdp-primer/overview/_index.adoc
+++ b/documentation/content/en/books/fdp-primer/overview/_index.adoc
@@ -70,6 +70,9 @@ First, subscribe to the {freebsd-doc}.
 Some team members also interact on the `#bsddocs` IRC channel on http://www.efnet.org/[EFnet].
 These people can help with questions or problems involving the documentation.
 
+[[freebsd-installation-process]]
+=== FreeBSD installation process
+
 [.procedure]
 ====
 . Install these packages. The `docproj` _meta-port_ installs all the applications required to do useful work with the FreeBSD documentation.
@@ -107,10 +110,67 @@ Repeat until all of the errors are resolved.
 ....
 +
 Give the diff file a descriptive name.
-In the example above, changes have been made to the [.filename]#bsdinstall# portion of the Handbook.
+In the example above, changes have been made to the *bsdinstall* portion of the Handbook.
++
 . Submit the diff file using the web-based https://bugs.FreeBSD.org/bugzilla/enter_bug.cgi?product=Documentation[Problem Report] system. If using the web form, enter a Summary of _[patch] short description of problem_. Select the Component `Documentation`. In the Description field, enter a short description of the changes and any important details about them. Use the btn:[Add an attachment] button to attach the diff file. Finally, use the btn:[Submit Bug] button to submit your diff to the problem report system.
 ====
 
+[[gnu-linux-installation-process]]
+=== GNU/Linux installation process
+
+[.procedure]
+====
+[TIP]
+======
+Hugo version 0.90 or higher must be used
+======
+
+. Install these packages in apt-based systems like Debian or Ubuntu.
+On other GNU/Linux distributions the package names may change.
+Consult your distribution's package manager if in doubt.
++
+[source,shell]
+....
+# apt install hugo ruby-asciidoctor ruby-asciidoctor-pdf ruby-rouge git bmake
+....
++
+. Install a local working copy of the documentation from the FreeBSD repository in [.filename]#~/doc# (see crossref:working-copy[working-copy,The Working Copy]).
++
+[source,shell]
+....
+% git clone https://git.FreeBSD.org/doc.git ~/doc
+....
++
+. Edit the documentation files that require changes. If a file needs major changes, consult the mailing list for input.
++
+Review the output and edit the files to fix any problems shown, then rerun the command to find any remaining problems.
+Repeat until all of the errors are resolved.
++
+. Always build and test the changes before submitting them. Running `bmake` in the top-level directory of the documentation will generate that documentation in HTML format.
++
+[source,shell]
+....
+% bmake run LOCALBASE=/usr
+....
++
+. When changes are complete and tested, generate a diff file:
++
+[source,shell]
+....
+% cd ~/doc
+% git diff > bsdinstall.diff
+....
++
+Give the diff file a descriptive name.
++
+. Submit the diff file using the web-based https://bugs.FreeBSD.org/bugzilla/enter_bug.cgi?product=Documentation[Problem Report] system.
+If using the web form, enter a Summary of _short description of problem_.
+Select the Component `Documentation`.
+In the Description field, enter a short description of the problem in the _Summary_ field and add _patch_ to the _Keywords_ field.
+Use the btn:[Add an attachment] button to attach the diff file.
+Finally, use the btn:[Submit Bug] button to submit your diff to the problem report system.
+====
+
 [[overview-doc]]
 == The FreeBSD Documentation Set