Page MenuHomeFreeBSD
Differential D30176 Diff 103371 documentation/content/en/books/fdp-primer/overview/_index.adoc

Changeset View

Standalone View

View Options

documentation/content/en/books/fdp-primer/overview/_index.adoc

Show First 20 Lines • Show All 95 Lines • ▼ Show 20 Lines
+ +
. *_Always_* build and test the changes before submitting them. Running `make` in the top-level directory of the documentation will generate that documentation in HTML format. . *_Always_* build and test the changes before submitting them. Running `make` in the top-level directory of the documentation will generate that documentation in HTML format.
+ +
[source,shell] [source,shell]
.... ....
% make % make
.... ....
+ +
. When changes are complete and tested, generate a "diff file": . When changes are complete and tested, generate a "diff file":
bcrUnsubmitted
Done
Inline Actions

s/differeces/differences/

bcr: s/differeces/differences/
ygyUnsubmitted
Done
Inline Actions

syntax*

ygy: syntax*
pauamma_gundo.comUnsubmitted
Done
Inline Actions
....
+
- On macOS and Linux, install and use bmake because GNU Make doesn't work due to the differences of syntax.
+ On macOS and Linux, install and use bmake because GNU Make doesn't work due to the syntax differences.
+
. When changes are complete and tested, generate a "diff file":
pauamma_gundo.com:
+ +
[source,shell] [source,shell]
.... ....
% cd ~/doc % cd ~/doc
% git diff > bsdinstall.diff.txt % git diff > bsdinstall.diff.txt
.... ....
+ +
Give the diff file a descriptive name. Give the diff file a descriptive name.
In the example above, changes have been made to the *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. . 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]] [[macOS-and-gnu-linux-installation-process]]
=== GNU/Linux installation process === macOS and GNU/Linux installation process
[.procedure] [.procedure]
==== ====
[TIP] [TIP]
====== ======
Hugo version 0.90 or higher must be used Hugo version 0.90 or higher must be used
====== ======
. Install these packages in apt-based systems like Debian or Ubuntu.
. *_For macOS_*
+
Use Homebrew and RubyGem to install these packages.
+
[source,shell]
....
$ /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
$ brew install hugo ruby git bmake asciidoctor
$ echo 'export PATH="/usr/local/opt/ruby/bin:$PATH"' >> ~/.zshrc
$ sudo gem install rouge
....
+
*_For GNU/Linux_*
+
Install these packages in apt-based systems like Debian or Ubuntu.
On other GNU/Linux distributions the package names may change. On other GNU/Linux distributions the package names may change.
Consult your distribution's package manager if in doubt. Consult your distribution's package manager if in doubt.
+ +
[source,shell] [source,shell]
.... ....
# apt install hugo ruby-asciidoctor ruby-asciidoctor-pdf ruby-rouge git bmake # apt install hugo ruby-asciidoctor ruby-asciidoctor-pdf ruby-rouge git bmake
.... ....
+ +
Show All 29 Lines
. Submit the diff file using the web-based https://bugs.FreeBSD.org/bugzilla/enter_bug.cgi?product=Documentation[Problem Report] system. . 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_. If using the web form, enter a Summary of _short description of problem_.
Select the Component `Documentation`. 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. 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. 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. Finally, use the btn:[Submit Bug] button to submit your diff to the problem report system.
==== ====
[[overview-doc]] [[overview-doc]]
== The FreeBSD Documentation Set == The FreeBSD Documentation Set
The FDP is responsible for four categories of FreeBSD documentation. The FDP is responsible for four categories of FreeBSD documentation.
* _Handbook_: The Handbook is the comprehensive online resource and reference for FreeBSD users. * _Handbook_: The Handbook is the comprehensive online resource and reference for FreeBSD users.
* _FAQ_: The FAQ uses a short question and answer format to address questions that are frequently asked on the various mailing lists and forums devoted to FreeBSD. This format does not permit long and comprehensive answers. * _FAQ_: The FAQ uses a short question and answer format to address questions that are frequently asked on the various mailing lists and forums devoted to FreeBSD. This format does not permit long and comprehensive answers.
* _Manual pages_: The English language system manual pages are usually not written by the FDP, as they are part of the base system. However, the FDP can reword parts of existing manual pages to make them clearer or to correct inaccuracies. * _Manual pages_: The English language system manual pages are usually not written by the FDP, as they are part of the base system. However, the FDP can reword parts of existing manual pages to make them clearer or to correct inaccuracies.
* _Web site_: This is the main FreeBSD presence on the web, visible at https://www.freebsd.org/[https://www.FreeBSD.org/] and many mirrors around the world. The web site is typically a new user's first exposure to FreeBSD. * _Web site_: This is the main FreeBSD presence on the web, visible at https://www.freebsd.org/[https://www.FreeBSD.org/] and many mirrors around the world. The web site is typically a new user's first exposure to FreeBSD.
Translation teams are responsible for translating the Handbook and web site into different languages. Translation teams are responsible for translating the Handbook and web site into different languages.
Manual pages are not translated at present. Manual pages are not translated at present.
Documentation source for the FreeBSD web site, Handbook, and FAQ is available in the documentation repository at `https://cgit.freebsd.org/doc/`. Documentation source for the FreeBSD web site, Handbook, and FAQ is available in the documentation repository at `https://cgit.freebsd.org/doc/`.
Source for manual pages is available in a separate source repository located at `https://cgit.freebsd.org/src/`. Source for manual pages is available in a separate source repository located at `https://cgit.freebsd.org/src/`.
Documentation commit messages are visible with `git log`. Documentation commit messages are visible with `git log`.
Commit messages are also archived at link:{git-doc-all}. Commit messages are also archived at link:{git-doc-all}.
pauamma_gundo.comUnsubmitted
Done
Inline Actions

Merge with previous section, "macOS and GNU/Linux"?

pauamma_gundo.com: Merge with previous section, "macOS and GNU/Linux"?
minsoochoo0122_proton.meAuthorUnsubmitted
Done
Inline Actions

Sorry. I forgot to delete it.

minsoochoo0122_proton.me: Sorry. I forgot to delete it.
Web frontends to both of these repositories are available at https://cgit.freebsd.org/doc/[] and https://cgit.freebsd.org/src/[]. Web frontends to both of these repositories are available at https://cgit.freebsd.org/doc/[] and https://cgit.freebsd.org/src/[].
Many people have written tutorials or how-to articles about FreeBSD. Many people have written tutorials or how-to articles about FreeBSD.
Some are stored as part of the FDP files. Some are stored as part of the FDP files.
In other cases, the author has decided to keep the documentation separate. In other cases, the author has decided to keep the documentation separate.
The FDP endeavors to provide links to as much of this external documentation as possible. The FDP endeavors to provide links to as much of this external documentation as possible.