From nobody Sat Apr 02 16:43:37 2022 X-Original-To: dev-commits-doc-all@mlmmj.nyi.freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2610:1c1:1:606c::19:1]) by mlmmj.nyi.freebsd.org (Postfix) with ESMTP id DC4291A5E424 for ; Sat, 2 Apr 2022 16:43:37 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from mxrelay.nyi.freebsd.org (mxrelay.nyi.freebsd.org [IPv6:2610:1c1:1:606c::19:3]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256 client-signature RSA-PSS (4096 bits) client-digest SHA256) (Client CN "mxrelay.nyi.freebsd.org", Issuer "R3" (verified OK)) by mx1.freebsd.org (Postfix) with ESMTPS id 4KW2t15WYJz3r14; Sat, 2 Apr 2022 16:43:37 +0000 (UTC) (envelope-from git@FreeBSD.org) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1648917817; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=F+mkUoMUbiCiLyBwTUHvR/l+GViZzF1BfJoDxoOOuhM=; b=uGAhvn1xnhb5FDkzNhQHCHPh9xScYjS9lox2TyhgAAcvRVnByNsy0IN6HqnmshP23xUYVf ZlEy7xi4kdLjrre4vcWAyW3O8LawykRPamDgG48r3KQRp3TRHZMfBmnU35GY4lBDuWxz7S DzTDd+h3+9YFpBqTPdkXCCQdrnHgeGpnVOlcbcLPIqIodIF3y04yE3OViRp2Aa3azjVJjo rclVLz5jTnlK/GgYoQwh6eBw/UnkuXXvy0BvVv1qvZMheYsohJ/bkJhX38cAvoK8EYMHcY iHQVX4lzTWHVZAIAdHPCd8adnbursrYRW3/4RsDBfimx+giGtvKbAHscqZzunQ== Received: from gitrepo.freebsd.org (gitrepo.freebsd.org [IPv6:2610:1c1:1:6068::e6a:5]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256) (Client did not present a certificate) by mxrelay.nyi.freebsd.org (Postfix) with ESMTPS id 9D4CB4AC1; Sat, 2 Apr 2022 16:43:37 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from gitrepo.freebsd.org ([127.0.1.44]) by gitrepo.freebsd.org (8.16.1/8.16.1) with ESMTP id 232GhbnJ060733; Sat, 2 Apr 2022 16:43:37 GMT (envelope-from git@gitrepo.freebsd.org) Received: (from git@localhost) by gitrepo.freebsd.org (8.16.1/8.16.1/Submit) id 232GhbUk060732; Sat, 2 Apr 2022 16:43:37 GMT (envelope-from git) Date: Sat, 2 Apr 2022 16:43:37 GMT Message-Id: <202204021643.232GhbUk060732@gitrepo.freebsd.org> To: doc-committers@FreeBSD.org, dev-commits-doc-all@FreeBSD.org From: Sergio Carlavilla Delgado Subject: git: 296b3da6c9 - main - Add instructions to build the documentation in macOS List-Id: Commit messages for all branches of the doc repository List-Archive: https://lists.freebsd.org/archives/dev-commits-doc-all List-Help: List-Post: List-Subscribe: List-Unsubscribe: Sender: owner-dev-commits-doc-all@freebsd.org X-BeenThere: dev-commits-doc-all@freebsd.org MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit X-Git-Committer: carlavilla X-Git-Repository: doc X-Git-Refname: refs/heads/main X-Git-Reftype: branch X-Git-Commit: 296b3da6c973fc6516d5c73b2aad49f5b31c71a3 Auto-Submitted: auto-generated ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1648917817; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=F+mkUoMUbiCiLyBwTUHvR/l+GViZzF1BfJoDxoOOuhM=; b=tHd54nuNWD+38LUeGUUYNKa8XZ2KuXTeQF0HltM7eP3/AXGkN6ByY3nC4nVRuxpZgvYbZJ 2IebofWtbvXA+bw3uSkfQ5QcAoMy6e4DUqPWcxj93hb9FOFu0riO1RsaPS57FCiaapRuMI /+U0dEf2LsJYsanrYe9oAH77+1SFTLzKVdRDHwmYPjtDmTh9YJPDZ4DYjGJtmwWHrbwViG QegmLmyIR9utI9AOuzBY9SjnO2lNVkZx8lya1jfRh4v8q5P9WcCw6EUkiijX6L4jqmOvOM l10zrR+LxAeilPpgbxG4Ny3D/M1g/gp8V/74AaeGuAWwnZD3vG8H49saP8QsiQ== ARC-Seal: i=1; s=dkim; d=freebsd.org; t=1648917817; a=rsa-sha256; cv=none; b=Cq5GPBuEwKdJjZjwhRc5Iryux6DNZGIG+wiPr6D5U88zc2zMSzokJxjcwjP9uTr3TRawvs qII6LRGCOrv1hk+HT9mVwOcmRw8wpgmUpkoYBat2s9lCqi/7zmGa3xi4qkXOxOqffT1JRn MnuCMGvbKx6IFZm+mAyeAUHlVShrnLyAtzq/gmHNhrBuUtLU0VusDoHNRwmgnoPFHt2ypF Kx2ljNy76GJvbG7L6Ggn3dwqDu//PBMF0XQDy/KCyeOMfjEFnSZ1tif2oHW2wimSxfTqN8 CtAMKjH1dDD0E0n/BFCXHFrMsmjp6VP216+UF9g3+RpTMUp8Cnvw0t4h6+3PyQ== ARC-Authentication-Results: i=1; mx1.freebsd.org; none X-ThisMailContainsUnwantedMimeParts: N The branch main has been updated by carlavilla: URL: https://cgit.FreeBSD.org/doc/commit/?id=296b3da6c973fc6516d5c73b2aad49f5b31c71a3 commit 296b3da6c973fc6516d5c73b2aad49f5b31c71a3 Author: Minsoo Choo AuthorDate: 2022-04-02 16:42:02 +0000 Commit: Sergio Carlavilla Delgado 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