git: 296b3da6c9 - main - Add instructions to build the documentation in macOS
- Go to: [ bottom of page ] [ top of archives ] [ this month ]
Date: Sat, 02 Apr 2022 16:43:37 UTC
The branch main has been updated by carlavilla:
URL: https://cgit.FreeBSD.org/doc/commit/?id=296b3da6c973fc6516d5c73b2aad49f5b31c71a3
commit 296b3da6c973fc6516d5c73b2aad49f5b31c71a3
Author: Minsoo Choo <fel1x.mintchoco.development_gmail.com>
AuthorDate: 2022-04-02 16:42:02 +0000
Commit: Sergio Carlavilla Delgado <carlavilla@FreeBSD.org>
CommitDate: 2022-04-02 16:42:02 +0000
Add instructions to build the documentation in macOS
Differential Revision: D30176, D34752
---
.../en/books/fdp-primer/overview/_index.adoc | 68 ++++++++++++++++++++++
1 file changed, 68 insertions(+)
diff --git a/documentation/content/en/books/fdp-primer/overview/_index.adoc b/documentation/content/en/books/fdp-primer/overview/_index.adoc
index c8b7335a88..6fe1fbb106 100644
--- a/documentation/content/en/books/fdp-primer/overview/_index.adoc
+++ b/documentation/content/en/books/fdp-primer/overview/_index.adoc
@@ -206,6 +206,74 @@ 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.
====
+[[mac-os-installation-process]]
+=== macOS(R) installation process
+
+[.procedure]
+====
+[TIP]
+======
+Hugo version 0.90 or higher must be used
+======
+
+. Install these packages using link:https://brew.sh/[Homebrew] and link:https://rubygems.org/[RubyGem].
++
+[source,shell]
+....
+$ brew install hugo ruby git bmake asciidoctor
+....
++
+. Add Ruby to the Path.
++
+[source,shell]
+....
+$ echo 'export PATH="/usr/local/opt/ruby/bin:$PATH"' >> ~/.zshrc
+....
++
+. Install the rouge package using RubyGem.
++
+[source,shell]
+....
+$ sudo gem install rouge
+....
++
+. 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