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

31 Commits

Author SHA1 Message Date
Sergio Carlavilla Delgado b3c6ff6ee1 Upgrade copyright year 2026-02-19 11:28:04 +01:00
Pouria Mousavizadeh Tehrani 169c613a70 checkkey.sh: Add EDDSA algo (RFC8032)
This fixes the UNKNOWN type returned by checkkey.sh

Reviewed by:		des, siva
Approved by:		glebius (mentor)
Differential Revision:	https://reviews.freebsd.org/D54473
2026-01-18 11:43:08 +03:30
Sergio Carlavilla Delgado 2c376bf316 Upgrade copyright years 2025-01-07 17:32:54 +01:00
Igor Ostapenko 8739d155b4 documentation/tools: Make *key.sh more portable
POSIX does not include ";&" as a case fallthrough syntax.

Reviewed by:	kp, des, markj
Approved by:	kp (mentor)
Differential Revision:	https://reviews.freebsd.org/D46453
2024-09-09 20:18:02 +00:00
Marc Fonvieille 415c95246b pgpkeys/README: s/programlisting/literal-block-margin where needed. 2023-12-10 16:06:05 +01:00
Sergio Carlavilla Delgado abe0978dfe Upgrade Copyright years 2023-04-04 20:07:56 +02:00
Alex Bylund 5795dee51d documentation: Fix styles of the HTML offline assets
PR:		268829
Co-authored-by:	Danilo G. Baio <dbaio@FreeBSD.org>
2023-03-30 21:22:25 -03:00
Danilo G. Baio 481bff5848 documentation/pdf: Remove scripts=cjk from asciidoctor-pdf build
There is a bug when building some documents, like the
porters-handbook/security chapter (callouts).
2023-01-20 23:39:39 -03:00
Yan Hao Wang 6a430fe152 documentation/pdf: Improve zh-cn|zh-tw font issues
The build script now uses fonts installed by the port/pkg
docproj-fonts-cjk.

Differential Revision:	https://reviews.freebsd.org/D36623
Differential Revision:	https://reviews.freebsd.org/D37447
Co-authored-by:	Danilo G. Baio <dbaio@FreeBSD.org>
2023-01-20 21:14:53 -03:00
Minsoo Choo d9fc0784a8 Update build instructions for macOS
Approved by:                    carlavilla@
Reviewed by:                    Jose Luis Duran <jlduran_gmail.com>
Differential Revision:          https://reviews.freebsd.org/D37143
2022-11-02 22:42:32 +01:00
Guangyuan Yang a041a9ec60 Fix the dir of my (ygy@) PGP key
Reported by:	arrowd
2022-03-22 01:17:13 -04:00
Guangyuan Yang 323733df35 Add back my (ygy@) PGP key 2022-03-21 01:05:54 -04:00
Sergio Carlavilla Delgado 56d044a88b Bump copyright year to 2022 2022-01-02 16:41:41 +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
Danilo G. Baio 82c271aa23 documentation: Add experimental support for EPUB output 2021-11-06 10:56:04 -03:00
Danilo G. Baio 038be2aa83 documentation: Add an option to archive/compress HTML offline files
Reviewed by:	carlavilla
Differential Revision:	https://reviews.freebsd.org/D32867
2021-11-06 08:08:24 -03: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
Mateusz Piotrowski 77a07a9384 checkkey: Fix typos in comments
Reported by:	Pau Amma
2021-10-13 13:30:35 +02:00
Mateusz Piotrowski d0b8158d66 checkkey: Make the script work for logins starting with digits
Differential Revision:	https://reviews.freebsd.org/D16548
2021-10-13 08:49:59 +02:00
Ceri Davies 55ff91a87b documentation/tools: warn, but don't fail, on languages without books.
This allows us to pass a full list of languages to the pdf target.
The -o option does not warn, continuing merely to print a list of files
that it would create.
2021-06-16 21:00:26 +01:00
Ceri Davies c4db9c153e tools/books*py: improve argument handling of DOC_LANG, and others
1) fix shebang lines;
2) add a -o option that makes no changes but prints the files that
    would be updated/created;
3) allow the -l argument (and therefore DOC_LANG) to be whitespace
    separated, comma separated, or a mixture of both

Item 2 allows us to start tracking dependencies in Makefiles if we wish
and therefore reintroduce incremental builds, reducing the amount of
.PHONY targets that are not truly phony.

Item 3 restores compability with the documented DOC_LANG variable, which
was previously whitespace separated.

Reviewed by:	dbaio, blackend
Differential Revision:	https://reviews.freebsd.org/D30732
2021-06-13 13:45:07 +01:00
Ceri Davies 752f1f74b1 documentation/tools: Update guidance.
I forgot to "git add" this in r7c1856c, which changed the required
format for pgpkey entries in articles/pgpkeys/

Approved by:	blackend (mentor)
2021-05-24 09:54:27 +01:00
Sergio Carlavilla Delgado adda9a6066 Link to the new pgpkeys.txt file in articles and books
Link in articles and books to the new pgpkeys.txt file
Remove all AsciiDoc syntax in pgpkeys.txt

PR:             254636
Submitted by:   dinoex@
2021-05-23 21:33:46 +02:00
Sergio Carlavilla Delgado 0030e0f18a Remove comment and CSS class from the pgpkeys.txt file 2021-05-23 21:00:35 +02:00
Sergio Carlavilla Delgado 5a9f8ba840 Add new tool to generate the pgpkeys.txt file 2021-05-16 22:41:00 +02:00
Ceri Davies 6fb837b028 Update instructions on adding new committer entries.
Approved by:	blackend (mentor)
2021-05-14 15:53:36 +01:00
Sergio Carlavilla Delgado cd5051bbed Modify the script used to generate the ToC parts
Modify the script used to generate the different ToC
for the partN.adoc files
2021-03-31 23:52:38 +02:00
Sergio Carlavilla Delgado f8fed61b80 Split porters handbook
Split the porters handbook into different chapters like the handbook
2021-03-31 23:13:10 +02:00
Ed Maste fbc1409c73 Use @generated in generated files
@generated is used by various tools to identify generated files.
For example, Phabricator will not display diffs in generated files
by default.

Reviewed by:	gjb
Sponsored by:	The FreeBSD Foundation
Differential Revision:	https://reviews.freebsd.org/D28446
2021-02-04 09:39:06 -05:00
Sergio Carlavilla Delgado 57930f3fd5 Upgrade pgpkeys related tools and committers guide new committer section 2021-02-01 22:23:03 +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