From nobody Fri Feb 17 18:50:09 2023 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 4PJLTs31MJz3rK8V for ; Fri, 17 Feb 2023 18:50:09 +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 4PJLTs1ft4z40kd; Fri, 17 Feb 2023 18:50:09 +0000 (UTC) (envelope-from git@FreeBSD.org) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1676659809; 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=ZcYXbTlThCvbsnwKIZiCdNCLqH7lU3jWkEwTBbecRuU=; b=M2RzqLPqcl3/TnlrcFJTGsHL+/vXZLsQwWat+xuuHXyl8uiybrm6WTuYQChHbRwhT29AO0 YVmaiNQ8ROvpssWqYfyXG4JOPhYSn9ZyJS7lBam4iW1VsCVs1VyJ7b781b2h7i82h/tu4a PGLThX+7PU2BH4a6RM8mKhcXloheJqWyr4scjWNQqi8/M3Rt8jRjFDLyz79wC5qtrkKn/b TKpWo7yKY9aGwZs2tHOpFqyll1zaHd+bnE8N5NK5J7hUw2NhwR+Rt6bofgySf9hcfIcJ/P S7linDeL5NRKhkmEvkWLouh5Lh5lVMjpuRsdB5VW7BI6FEN6erdiiLsD1GTUPQ== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1676659809; 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=ZcYXbTlThCvbsnwKIZiCdNCLqH7lU3jWkEwTBbecRuU=; b=Bv12wnlScWVxJeHxH4XSBZGgv0zJKQj2fN/MxydEry0yFV5i44/3UznFFBTle6UAHHHpe8 GjmAHYFsTccRLQPZ3N8s+dW1h6c1yRSKE/mCEAcyOvMnUCjzaA7hyo+BuhpcViYJwbhnm5 s98K5ISFVpjPbDq24aaDpKPD7nfUulJou+juV/50tNRn/xsgYPqssdMQrkN/TdkL0I1qQ5 UnUug3NpLOvCTrIRfRCOCTPHDQDT1YJbzxCi4LNgPbWtgF5AFnURRvWHvshNVEY9Mqo50S TrM3CU/Qmg4XbrM7/oBox5imEBYzFroOzN4Sd2coYfgUMOv5pSWIdnU1R5dTVA== ARC-Authentication-Results: i=1; mx1.freebsd.org; none ARC-Seal: i=1; s=dkim; d=freebsd.org; t=1676659809; a=rsa-sha256; cv=none; b=gqwWKNNQ+ppdSsAnMqNkoFj8DYyNgfmoIRsq19GP/ob/mnoL+3SPBFid7N/NPUcBH8oHfN tJX8ONCmDuQbYHoJ5yzEIHY+NLvz/4mVfDG0MXaVnfuTBs+Smrtv9JokFmPR5uy3qQmltf fvzs0tSWGU7ykPwfcX7qDeewX32pP9XXO6L5gnR5TsojtYvHSskHs3tYUfJcW09j3tNOZy pe1L++ydDzqwHcrgMPd0+R8fYK16tTpIPivzBlg5qSC5pdaTiXvF3mHxgUOAvgBZRYsRK6 tlWS7Z+1NwCGsO3VUbmZU9CAMQDlpRq3x5Q50p05uPD78wZqlkKx+VUZfCIadw== 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 4PJLTs0jqWzsyh; Fri, 17 Feb 2023 18:50:09 +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 31HIo9iE000803; Fri, 17 Feb 2023 18:50:09 GMT (envelope-from git@gitrepo.freebsd.org) Received: (from git@localhost) by gitrepo.freebsd.org (8.16.1/8.16.1/Submit) id 31HIo9Lj000795; Fri, 17 Feb 2023 18:50:09 GMT (envelope-from git) Date: Fri, 17 Feb 2023 18:50:09 GMT Message-Id: <202302171850.31HIo9Lj000795@gitrepo.freebsd.org> To: doc-committers@FreeBSD.org, dev-commits-doc-all@FreeBSD.org From: Sergio Carlavilla Delgado Subject: git: 1aadaf5e4a - main - Improve documentation build instructions 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: 1aadaf5e4a1c7b4792cebd628268b14fdd97e622 Auto-Submitted: auto-generated X-ThisMailContainsUnwantedMimeParts: N The branch main has been updated by carlavilla: URL: https://cgit.FreeBSD.org/doc/commit/?id=1aadaf5e4a1c7b4792cebd628268b14fdd97e622 commit 1aadaf5e4a1c7b4792cebd628268b14fdd97e622 Author: Sergio Carlavilla Delgado AuthorDate: 2023-02-17 18:47:45 +0000 Commit: Sergio Carlavilla Delgado CommitDate: 2023-02-17 18:47:45 +0000 Improve documentation build instructions With some minor improvements from the GitHub PR Reported by: Gaelan Lloyd Pull Request: https://github.com/freebsd/freebsd-doc/pull/110 --- .../content/en/books/fdp-primer/overview/_index.adoc | 13 ++++++++++++- 1 file changed, 12 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 6b1ce7554a..accae70a53 100644 --- a/documentation/content/en/books/fdp-primer/overview/_index.adoc +++ b/documentation/content/en/books/fdp-primer/overview/_index.adoc @@ -129,13 +129,24 @@ These people can help with questions or problems involving the documentation. Review the output and edit the file 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 `make` in the `documentation` or `website` subdirectories will generate the documentation in HTML format. +. *_Always_* build and review the changes before submitting them. Running `make` in the `documentation` or `website` subdirectories will generate the documentation in HTML format. + [source,shell] .... % make .... + +To reduce compile time, only one language can be compiled: ++ +[source,shell] +.... +% make DOC_LANG=en +.... ++ +The build output is stored in [.filename]#~/documentation/public/articles/`# and [.filename]#`~/documentation/public/books/`#. ++ +. Review the build output and ensure the edits are free from typos, layout problems, or errors. If any errors are found during the build process, edit the problematic files to fix any issues that show up, then run the build command again until all errors are resolved. ++ . Add all the files with `git add .`, then review the diff with `git diff`. For example: + [source,shell]