From nobody Mon Feb 28 18:05:33 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 4454E19F34F4 for ; Mon, 28 Feb 2022 18:05:34 +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 4K6pFp1RjJz3qwB; Mon, 28 Feb 2022 18:05:34 +0000 (UTC) (envelope-from git@FreeBSD.org) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1646071534; 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=Ms3LoH63fs8LW6tr/qZuYUwGkYRvobnRIC3s/sua/iI=; b=KqxLUVReVCZon+kE5CDLhpIyYpHo5BmBTV9K5d2mOGE7pwxzYsdt1Gh/ZnD17jUE41+SNV No/Qkdr963xuJt9ZNYGEem1C4NLyNavektmhQooviRXmJSbZwqH3U+9B/Htd6GA0H//gLn TETWCIrEF/FrzuK2Af/9VRIWzDkC/z9c0gMz3+IuFiT7cujuz2BRmlb80LIwb4sb0mbN8J n+/l0aDtq9X/k9fFoTtZgWHYqEGDilGjcLU0bwsDfBMpjYohp0OE+RA3+ZOS+EKlGHSIpf 4XuWKtFsC63K/tdWMOE6ydoc4YIIYu9H9cIBz9kFudQmGnQPwWOJN7DdRjM/cg== 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 0DD102026B; Mon, 28 Feb 2022 18:05:34 +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 21SI5Xu1086880; Mon, 28 Feb 2022 18:05:33 GMT (envelope-from git@gitrepo.freebsd.org) Received: (from git@localhost) by gitrepo.freebsd.org (8.16.1/8.16.1/Submit) id 21SI5Xn6086879; Mon, 28 Feb 2022 18:05:33 GMT (envelope-from git) Date: Mon, 28 Feb 2022 18:05:33 GMT Message-Id: <202202281805.21SI5Xn6086879@gitrepo.freebsd.org> To: doc-committers@FreeBSD.org, dev-commits-doc-all@FreeBSD.org From: Sergio Carlavilla Delgado Subject: git: 815fb2e573 - main - Add instructions to build the documentation using GNU/Linux 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: 815fb2e573c0e6484c4e0622c216bb8c2895e307 Auto-Submitted: auto-generated ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1646071534; 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=Ms3LoH63fs8LW6tr/qZuYUwGkYRvobnRIC3s/sua/iI=; b=m4Ny254W4tW5XyZruMJavSdeUz+CBoqQhdDc2rnXz6g+W9uzkYj7ZSGBeHJur0B+KNLdgT C9+QiMErnTdO41JAPtN/4qaM63ZMohNmT7BRLh6tP0V4Za7LMz4OVBuCvo+8gKQF4GbjMk Ia/Ef8H2UIsht+4Jvd5CF//InSFRArSi0UJi0xXY5Gt8QuF43Pb19DC4oamUCQ0Ht3MtJf gQH1HQQZmJREk/azOLXDoiR3dOcFENYY6NmFFAYWQS+mUG0syzeZiFWjYycDgtxWMFc3Ly NbCKVKXSw55ypYVYG8iO8Lg8JqTWZ8D5ILwoyfTlwE+iUMWJNkWNy5nips54Dw== ARC-Seal: i=1; s=dkim; d=freebsd.org; t=1646071534; a=rsa-sha256; cv=none; b=Ux5AuUBFWNVyK0O5+JJnRjnFTpUtS19wmTDCW5c0N9etimzNGl8R8Ksznpescjk1FW1SuZ vK3jzzVKoe+37XzWzsIBblfapxA9wI1gqCkuzg90Ask0vj06zyDx0Hwan+fT/3ubT8J+aq Ys6Ijl2LpFre0BlCUrZCS65lFd8u1dbYEbUSl0MHm/hcF1T0wuUsEzhjSefVInHuW55LV0 syPWV3cABRrAjvUFcfzNAHmF5O8/Bt4gj7qxNCsyGB1gRKfW6KoWmKDWFLVprZ6Sn+vDHo AdroCLlTypK0WpDPn1hoT+A3R3d2Kbw8Nn3OjUkqPoQD1KrV4p/RMUPGZ8vv3A== 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=815fb2e573c0e6484c4e0622c216bb8c2895e307 commit 815fb2e573c0e6484c4e0622c216bb8c2895e307 Author: Sergio Carlavilla Delgado AuthorDate: 2022-02-28 18:04:14 +0000 Commit: Sergio Carlavilla Delgado CommitDate: 2022-02-28 18:04:14 +0000 Add instructions to build the documentation using GNU/Linux Reviewd by: debdrup@, Pau Amma 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