aboutsummaryrefslogtreecommitdiff
path: root/documentation/tools
Commit message (Collapse)AuthorAgeFilesLines
* Upgrade copyright yearsSergio Carlavilla Delgado2025-01-071-2/+2
|
* documentation/tools: Make *key.sh more portableIgor Ostapenko2024-09-092-15/+16
| | | | | | | | 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
* pgpkeys/README: s/programlisting/literal-block-margin where needed.Marc Fonvieille2023-12-101-1/+1
|
* Upgrade Copyright yearsSergio Carlavilla Delgado2023-04-041-2/+2
|
* documentation: Fix styles of the HTML offline assetsAlex Bylund2023-03-311-0/+3
| | | | | PR: 268829 Co-authored-by: Danilo G. Baio <dbaio@FreeBSD.org>
* documentation/pdf: Remove scripts=cjk from asciidoctor-pdf buildDanilo G. Baio2023-01-211-1/+1
| | | | | There is a bug when building some documents, like the porters-handbook/security chapter (callouts).
* documentation/pdf: Improve zh-cn|zh-tw font issuesYan Hao Wang2023-01-211-1/+24
| | | | | | | | | 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>
* Update build instructions for macOSMinsoo Choo2022-11-021-3/+10
| | | | | | Approved by: carlavilla@ Reviewed by: Jose Luis Duran <jlduran_gmail.com> Differential Revision: https://reviews.freebsd.org/D37143
* Fix the dir of my (ygy@) PGP keyGuangyuan Yang2022-03-221-80/+0
| | | | Reported by: arrowd
* Add back my (ygy@) PGP keyGuangyuan Yang2022-03-211-0/+80
|
* Bump copyright year to 2022Sergio Carlavilla Delgado2022-01-021-2/+2
|
* New Documentation PortalSergio Carlavilla Delgado2021-12-115-887/+0
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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
* documentation: Add experimental support for EPUB outputDanilo G. Baio2021-11-061-2/+57
|
* documentation: Add an option to archive/compress HTML offline filesDanilo G. Baio2021-11-061-17/+65
| | | | | Reviewed by: carlavilla Differential Revision: https://reviews.freebsd.org/D32867
* Build offline documentation using Hugo and other improvementsSergio Carlavilla Delgado2021-11-036-25/+177
| | | | | | | | | | | | | | | | | | | | | | * 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
* checkkey: Fix typos in commentsMateusz Piotrowski2021-10-131-2/+2
| | | | Reported by: Pau Amma
* checkkey: Make the script work for logins starting with digitsMateusz Piotrowski2021-10-131-2/+2
| | | | Differential Revision: https://reviews.freebsd.org/D16548
* documentation/tools: warn, but don't fail, on languages without books.Ceri Davies2021-06-165-0/+29
| | | | | | 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.
* tools/books*py: improve argument handling of DOC_LANG, and othersCeri Davies2021-06-135-50/+117
| | | | | | | | | | | | | | | | | | 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
* documentation/tools: Update guidance.Ceri Davies2021-05-241-1/+1
| | | | | | | I forgot to "git add" this in r7c1856c, which changed the required format for pgpkey entries in articles/pgpkeys/ Approved by: blackend (mentor)
* Link to the new pgpkeys.txt file in articles and booksSergio Carlavilla Delgado2021-05-231-1/+4
| | | | | | | | Link in articles and books to the new pgpkeys.txt file Remove all AsciiDoc syntax in pgpkeys.txt PR: 254636 Submitted by: dinoex@
* Remove comment and CSS class from the pgpkeys.txt fileSergio Carlavilla Delgado2021-05-231-1/+3
|
* Add new tool to generate the pgpkeys.txt fileSergio Carlavilla Delgado2021-05-161-0/+34
|
* Update instructions on adding new committer entries.Ceri Davies2021-05-142-14/+15
| | | | Approved by: blackend (mentor)
* Modify the script used to generate the ToC partsSergio Carlavilla Delgado2021-03-311-43/+49
| | | | | Modify the script used to generate the different ToC for the partN.adoc files
* Split porters handbookSergio Carlavilla Delgado2021-03-311-46/+48
| | | | Split the porters handbook into different chapters like the handbook
* Use @generated in generated filesEd Maste2021-02-045-5/+5
| | | | | | | | | | @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
* Upgrade pgpkeys related tools and committers guide new committer sectionSergio Carlavilla Delgado2021-02-011-27/+10
|
* Migrate doc to Hugo/AsciiDoctorSergio Carlavilla Delgado2021-01-259-0/+1466
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