1
0
mirror of https://git.FreeBSD.org/doc.git synced 2026-06-02 19:35:07 +00:00

36 Commits

Author SHA1 Message Date
Vladlen Popolitov 966a1a9d8d docs: fix broken cross-references by using numeric values for isOnline
Reviewed by: carlavilla
Approved by: carlavilla
Differential Revision: https://reviews.freebsd.org/D57098
PR: 295112
2026-05-19 22:31:23 +03:00
Sergio Carlavilla Delgado b59712185a Documentation: Fix gohugo warnings 2026-05-17 20:03:59 +02:00
Danilo G. Baio 8bf50482b5 doc/config/offline: Allow git command
Following 826d39cdc4
2024-09-07 11:13:39 -03:00
Fernando Apesteguía 826d39cdc4 Allow git command
Use the default configuration as show in the Hugo site:
https://gohugo.io/about/security/#security-policy

Necessary for the upcoming update to hugo 0.133.0
2024-08-19 17:57:41 +02:00
Marc Fonvieille 1d9a1db29c offline/config.toml: Remove unknown output configurations list and
`single`
2024-02-17 13:12:34 +01:00
Minsoo Choo f3d9ae979e Remove warnings in configuration files
From Hugo doc:

> With v0.109.0 and earlier the basename of the site configuration file was
config instead of hugo. You can use either, but should transition to the new
naming convention when practical.

Therefore `config.toml` is moved to `hugo.toml`.

> The taxonomyTerm page kind was effectively aliased to the taxonomy page kind
in v0.73.0 (https://github.com/bep/hugo/commit/114d4012a89ca88583de5979a6ec4a4799c739b7)

`list` and `single` are unknown configurations. Remove them.

Differential Revision: https://reviews.freebsd.org/D43406
2024-01-22 10:10:56 +01:00
Danilo G. Baio 3557dff6c5 doc: Increase Hugo timeout
We are receiving several reports of pkg-fallouts with the error message
"... timed out after 1m0s."
2024-01-16 22:02:21 -03:00
Li-Wen Hsu ba67c2538e Hugo config: Set timeout for 60s
In 93f1bbf374 we wanted to double the
default timeout, set it explicitly.

Ref:
 * https://gohugo.io/getting-started/configuration/#timeout
 * https://pkg.go.dev/time#Duration

Sponsored by:	The FreeBSD Foundation
2024-01-11 01:38:25 +08:00
Sergio Carlavilla Delgado e52c79320b Documentation Portal: Move GitHub url from edit to blob
Approved by:            fernape@, dbaio@ by email
Differential Revision:  https://reviews.freebsd.org/D41601
2023-08-30 17:40:00 +02:00
Danilo G. Baio 4971f6343d doc: Increase Hugo timeout for default builds
Some developers and contributors have reported experiencing timeouts
when using cloud VMs with low resources.  Configure the same timeout as
that used for offline builds.
2023-04-24 21:50:20 -03:00
Danilo G. Baio 8975ae3a55 doc: Increase Hugo timeout for offline builds
I still hit the timeout when building misc/freebsd-doc-* ports in
parallel on poudriere.

And occasionally we are receiving package-fallouts because of this.
2023-04-19 21:49:05 -03:00
Sergio Carlavilla Delgado a6a08d99bf Increase Hugo timeout for offline build 2023-04-10 10:51:45 +02:00
Sergio Carlavilla Delgado 93f1bbf374 Increase Hugo timeout
In some situations the default timeout in Hugo was not enough
The timeout is doubled
2023-04-09 12:15:39 +02:00
Sergio Carlavilla Delgado b68e44392b Move heading anchors to the end and add improve rendering on mobile 2022-09-01 21:17:02 +02:00
Sergio Carlavilla Delgado 52e33b2723 Activate section anchors in the Documentation Portal
Right now every heading except the main one will display an
anchor when the cursor is over the heading.

In this way parts of the documentation can be easily shared
only clicking in the anchor.
2022-07-15 11:52:35 +02:00
Sergio Carlavilla Delgado 4cf02aa484 Activate git info in the documentation portal and in the website
In all pages except the main page for documentation portal
and website will be shown information about who made the last
modification and when.

Thanks to dbaio@ and lwhsu@ to work into the CI infrastructure
to reactivate the git info :)
2022-04-08 21:33:12 +02:00
Azrael JD 349230aa5d Add Indonesian translation of Mailing List FAQ article
As this is a new language in the FreeBSD documentation, other
files/translations were added together.

Reviewed by:	dbaio (translating it back to English)
Approved by:	dbaio (doceng)

Differential Revision:	https://reviews.freebsd.org/D34599
Co-authored-by:	  Danilo G. Baio <dbaio@FreeBSD.org>
2022-03-31 18:44:06 -03:00
Sergio Carlavilla Delgado a5470d7e19 Disable Git information
The Hugo git information fails in the jenkins instance.
Disable until find a proper solution.
2022-03-25 21:57:32 +01:00
Sergio Carlavilla Delgado 352543bff3 Add last modified to documentation and website
Add the last modified information to the articles and books
in the Documentation Portal and in the website.
2022-03-25 21:45:18 +01:00
Sergio Carlavilla Delgado 7a3abf9d3e Remove Google Analytics
Remove Google Analytics from the Website and from the
Documentation Portal.

Also upgrade the FreeBSD's privacy policy page to reflect the
Google Analytics removal.

In the near future it will be replace with an open source alternative

Approved by:    core@, webmaster@
2022-03-21 21:58:59 +01:00
Sergio Carlavilla Delgado df67e600e8 Activate download pdf links for articles and books 2022-02-28 20:48:25 +01:00
Sergio Carlavilla Delgado 7fe378266a Fix problems with links and CSS in offline mode
Reported by:    dbaio@
2022-01-29 22:02:15 +01:00
Sergio Carlavilla Delgado 8624558756 Activate the edit button for articles and books 2021-12-27 22:15:50 +01:00
Sergio Carlavilla Delgado 0372c6063e Add new security configuration to Hugo configuration.
Hugo added a security policy in 0.91 version to restric access to
os/exec, remote communication and similar as can be readed here[1]

* Allow the use of AsciiDoctor to 'exec'
* Add 'LOAD_PATH' and 'RUBYLIB' to 'osEnv' variables to allow the
use of custom AsciiDoctor extensions

Reported by:    Li-Wen Hsu

[1] https://gohugo.io/about/security-model/
2021-12-27 09:24:10 +01:00
Sergio Carlavilla Delgado e099a72b5e Upgrade FreeBSD Documentation Portal title to Documentation Portal
PR:             259371
Submitted by:   Graham Perrin <grahamperrin (AT) gmail.com>
2021-12-26 22:41:10 +01:00
Sergio Carlavilla Delgado 22024328a9 Fix download link and translate Hugo theme to Spanish 2021-12-11 12:55:14 +01:00
Sergio Carlavilla Delgado 2b027dd017 New Documentation Portal
I'm very pleased to announce the release of
our new Documentation Portal.

Key features:
* Responsive
* Modern design
* Theme support: Light, Dark, High contrast
* Removed Python dependency

Acknowledgment:

* Alexander Leidinger <netchild (at) FreeBSD.org>
* Baptiste Daroussin <bapt (at) FreeBSD.org>
* Benedict Reuschling <bcr (at) freebsd.org>
* Daniel Ebdrup Jensen <debdrup (at) FreeBSD.org>
* Danilo G. Baio <dbaio (at) FreeBSD.org>
* Dave Cottlehuber <dch (at) FreeBSD.org>
* Ed Maste <emaste (at) FreeBSD.org>
* Fernando Apesteguía <fernape (at) FreeBSD.org>
* Pedro Giffuni <pfg (at) FreeBSD.org>
* Joseph Mingrone <jrm (at) ftfl.ca>
* Rocky Hotas <rockyhotas (at) firemail.cc>
* Pau Amma <pauamma (at) gundo.com>
* The FreeBSD Foundation

Approved by: core, doceng
2021-12-11 10:57:33 +01:00
Sergio Carlavilla Delgado 64acd169b8 Build offline documentation using Hugo and other improvements
* Allow to build the documentation offline using Hugo
* Fix link problems
* Remove SVN entities
* Fix lang problems to help weblate
* Move all the AsciiDoctor translations to the shared folder to
  help weblate
* Allow the possibility to build each document. For example each
document can be edited in and watched the result in real time in
VS Code or Vim/NeoVim.

Breaking changes:

Eliminate the possibility of building books or articles.
They must be builded at the same time.
This functionality will be restored when version 0.89.0 is in the
repositories in a couple of weeks.

Reviewed by:            dbaio@
Differential Revision:  https://reviews.freebsd.org/D31926
2021-11-03 17:44:52 +01:00
Danilo G. Baio bc33e86596 documentation: Fix bn-bd language config 2021-10-09 17:54:50 -03:00
Danilo G. Baio aaa5068963 hugo: Ignore gettext po files when building 2021-06-12 09:27:12 -03:00
Sergio Carlavilla Delgado 0d9894b11e Improve the SEO of the documentation portal
Changes:
- Add the description meta tag in the index, articles and books
- Add a brief description in each article and book.
- Remove the SVN expansion tag
2021-05-02 00:54:35 +02:00
Sergio Carlavilla Delgado 284030c301 Allow building the documentation and the website with upstream hugo
When we build our documentation and website we use a hacked version
of www/gohugo that allows for arbitrary asciidoc extensions.
This was added as a patch in r562416.

The suggested pull request[1] this patch was based on was not
accepted "as is" and only allows the execution of extensions in
Ruby's $LOAD_PATH.

With these changes, we add our <docroot>shared/lib directory to
Ruby's library directory so we can load our custom extensions. This
also allows building the docs and website outsite FreeBSD using
upstream and unmodified tools.

Tested with the upcoming vanilla gohugo-0.82 provided by
gohugo's maintainer.

[1] https://github.com/gohugoio/hugo/pull/8131

Patch by:               fernape@
Differential Revision:  https://reviews.freebsd.org/D29410
2021-03-31 20:44:54 +02:00
Sergio Carlavilla Delgado fb36cfdfb2 Add gitref macro to reference a git hash
With this extension a git hash can be easily referenced.

The porters handbook versions chapter uses this extension
as an example in the FreeBSD 14.0 version table.

An example of use

gitref:hash[repository="src|doc|ports",length=hash-longitude]

The repository should be src, doc or ports.
And if no length it's specified the macro will use 12 characters
of the specified hash.

PR:             253050
Submitted by:   jhb@
2021-02-13 22:22:34 +01:00
Li-Wen Hsu ebd47aa134 Use production setting
PR:		253134
Reported by:	wosch
Approved by:	carlavilla (implicitly)
2021-02-07 13:05:13 +08:00
Sergio Carlavilla Delgado 7808bd27ab Enable robots.txt in docs.freebsd.org
Enable again robots.txt for docs.freebsd.org

PR:             253031
Submitted by:   wosch@
2021-01-26 20:17:05 +01: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