Commit graph

18 commits

Author SHA1 Message Date
Li-Wen Hsu
a9a9e66105
Use correct syntax markup for shell
Approved by:	carlavilla
2021-03-14 20:08:55 +08:00
Sergio Carlavilla Delgado
4f24ed91c2 Add example to generate pdf document in FDP
PR:             253178
Submitted by:   kib@
2021-03-03 21:13:08 +01:00
Ceri Davies
a0f7ad455b Multiple files: Fix 'shared' references
The hier(7) man-page lists /usr/share as the location for
architecture-independent files, so fix a few instances where the
documentation referes to /usr/shared instead of /usr/share.

PR:		253760
2021-02-22 19:29:41 +01:00
Sergio Carlavilla Delgado
554d53992e Remove RCS recommendation in the translations section of FDP
PR:         253556
Patch by:   ceri (AT) submonkey.net
2021-02-16 22:24:21 +01:00
Yasuhiro Kimura
8750cad450 Makefiles and FDP: Change python binary
Currently '/usr/local/bin/python3.7' is used as the value of
PYTHON_CMD. Right now this works because 3.7 is the default version of
Python 3 in the ports tree. However, at some point in the future, this
will be undoubtedly be changed.

It is also possible that users already might be building versions
newer than the default port/package, which needs to be an supported as
well.

In addition, the FDP recommends installing the 'python3' package. This
meta port/package depends on the default version of python, and
automatically creates a symlink to the default version.

With all this in mind, use '/usr/local/bin/python3' is used as the value
of PYTHON_CMD, since this means that the instructions will work
irrespective of which version is assigned.
2021-02-16 19:29:11 +01:00
Daniel Ebdrup Jensen
4023bd3f77 FDP: Fix typo
Reported by:	ceri
2021-02-13 19:43:27 +01:00
Daniel Ebdrup Jensen
b046222873 FDP: Remove extraneous article
Pointy hat to:	me
Reported by:	PauAmma
2021-02-13 07:14:24 +01:00
Yasuhiro Kimura
b474a50019 FDP: Refer to the proper package name for hugo
The package name 'hugo' refers to emulators/hugo, a PC Engine
(TurboGrafx 16) emulator, whereas the hugo that is required by the new
framework is www/gohugo. A similar case applies with the package name of
AsciiDoctor, which is 'rubygem-asciidoctor'.
Therefore fix package names so they refer to proper ones.

PR:		253470
2021-02-12 22:57:29 +01:00
Daniel Ebdrup Jensen
04b118c626 FDP: Correct some grammar and mistakes
Correct some grammar, some factual information and a misrepresentation
of that the "word list" is.

Submitted by:	ceri
PR:		253467
2021-02-12 20:52:02 +01:00
Ceri Davies
95da5a5d64 Correct the grammar in a sentence about beastie.png
PR:		253352
2021-02-08 19:41:15 +01:00
Brandon Bergren
bd3ec6a734 Trivial change: Remove duplicated paragraph. 2021-02-02 10:19:12 -06:00
Sergio Carlavilla Delgado
67b8d471d4 Remove unnecessary step in FDP quick start guide
Remove unnecessary step when the user install
the required tools for the website and documentation.

There's no need to move the shared folder between projects
2021-01-29 18:23:26 +01:00
Sergio Carlavilla Delgado
85faabdc47 Update build chapter in FDP
Update the build chapter in the FDP to reflect the new
build system.

Patch by:               kevans@
Differential Revision:  https://reviews.freebsd.org/D28409
2021-01-29 18:20:04 +01:00
Sergio Carlavilla Delgado
a62f2c7bd3 Fix a few nits in the Rosetta stone section of the FDP primer.
Patch by:               pauamma_gundo.com
Differential Revision:  https://reviews.freebsd.org/D28360
2021-01-27 21:01:04 +01:00
Sergio Carlavilla Delgado
ab8cd36cda Improve the column widths of various pages in the FDP
Patch by:               allanjude@
Differential Revision:  https://reviews.freebsd.org/D28358
2021-01-26 20:45:47 +01:00
Michael Gmelin
b0a56f2891 Correct simple typo.
Summary: Really simple typo, good change to test the new workflow.

Test Plan: None

Reviewers: carlavilla

Reviewed By: carlavilla

Differential Revision: https://reviews.freebsd.org/D28348
2021-01-26 13:58:17 +01:00
Allan Jude
ca50c35a68 Add a missing space to unbreak rendering of chapters-order sub-heading 2021-01-26 03:41:14 +00:00
Sergio Carlavilla Delgado
989d921f5d Migrate doc to Hugo/AsciiDoctor
I'm very pleased to announce the release of
our new website and documentation using
the new toolchain with Hugo and AsciiDoctor.

To get more information about the new toolchain
please read the FreeBSD Documentation Project Primer[1],
Hugo docs[2] and AsciiDoctor docs[3].

Acknowledgment:
Benedict Reuschling <bcr@>
Glen Barber <gjb@>
Hiroki Sato <hrs@>
Li-Wen Hsu <lwhsu@>
Sean Chittenden <seanc@>
The FreeBSD Foundation

[1] https://docs.FreeBSD.org/en/books/fdp-primer/
[2] https://gohugo.io/documentation/
[3] https://docs.asciidoctor.org/home/

Approved by:    doceng, core
2021-01-26 00:31:29 +01:00