diff options
author | Sergio Carlavilla Delgado <carlavilla@FreeBSD.org> | 2023-02-17 18:47:45 +0000 |
---|---|---|
committer | Sergio Carlavilla Delgado <carlavilla@FreeBSD.org> | 2023-02-17 18:47:45 +0000 |
commit | 1aadaf5e4a1c7b4792cebd628268b14fdd97e622 (patch) | |
tree | ab7009ccc421bb594020aa603546cb294e1d286a | |
parent | d473b10888eabdad1cb72c333636172c6c6db67f (diff) | |
download | doc-1aadaf5e4a1c7b4792cebd628268b14fdd97e622.tar.gz doc-1aadaf5e4a1c7b4792cebd628268b14fdd97e622.zip |
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
-rw-r--r-- | documentation/content/en/books/fdp-primer/overview/_index.adoc | 13 |
1 files changed, 12 insertions, 1 deletions
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] |