aboutsummaryrefslogtreecommitdiff
path: root/documentation/Makefile
Commit message (Collapse)AuthorAgeFilesLines
* Upgrade copyright yearSergio Carlavilla Delgado11 days1-2/+2
|
* Upgrade copyright yearsSergio Carlavilla Delgado2025-01-071-2/+2
|
* Documentation Portal - Makefile: Improve all target commentSergio Carlavilla Delgado2023-09-271-5/+6
| | | | | PR: 274073 Sponsored by: Daifressh
* doc: Remove build verbosity for the offline assets buildDanilo G. Baio2023-07-281-1/+1
| | | | The same has been made for the HTML build on 8548086.
* FDP: Upgrade MacOS build instructionsMinsoo Choo2023-07-141-1/+1
| | | | | | | - Upgrade MacOS build instructions - Remove tip about use Hugo 0.90 or higher Differential Revision: https://reviews.freebsd.org/D41036
* Upgrade Copyright yearsSergio Carlavilla Delgado2023-04-041-2/+2
|
* Remove build verbosity by defaultDanilo G. Baio2023-01-211-1/+1
| | | | | | | | | | | | | This way, it will be easier to identify warnings and errors from Hugo for anyone when working and building the website or the documentation portal. On CI, the builds have verbose and debug options enabled: ``` $ cd doc $ make HUGO_ARGS="--verbose --debug" ```
* Update build instructions for macOSMinsoo Choo2022-11-021-9/+19
| | | | | | Approved by: carlavilla@ Reviewed by: Jose Luis Duran <jlduran_gmail.com> Differential Revision: https://reviews.freebsd.org/D37143
* Add Indonesian translation of Mailing List FAQ articleAzrael JD2022-03-311-2/+2
| | | | | | | | | | | 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>
* Bump copyright year to 2022Sergio Carlavilla Delgado2022-01-021-2/+2
|
* New Documentation PortalSergio Carlavilla Delgado2021-12-111-39/+10
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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/Makefile: Fix commentDanilo G. Baio2021-11-061-1/+1
|
* documentation: Add experimental support for EPUB outputDanilo G. Baio2021-11-061-0/+57
|
* documentation: Add an option to archive/compress HTML offline filesDanilo G. Baio2021-11-061-2/+21
| | | | | Reviewed by: carlavilla Differential Revision: https://reviews.freebsd.org/D32867
* Build offline documentation using Hugo and other improvementsSergio Carlavilla Delgado2021-11-031-236/+43
| | | | | | | | | | | | | | | | | | | | | | * 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
* documentation: Remove asciidoctor-pdf from default requirementsDanilo G. Baio2021-10-091-3/+8
| | | | | | | | | | With the current requirements, if textproc/docproj is built with PDF option disabled, you can't build the documentation. This fixes that, and now asciidoctor-pdf will be checked only when building PDF. Reported by: jhb
* documentation/Makefile: change bd occurrences to bn-bdMarc Fonvieille2021-10-061-2/+2
|
* documentation/Makefile: correct error message if deps aren't found.Ceri Davies2021-08-281-1/+1
| | | | PR: 256523
* documentation/Makefile: have toc-clean target check for empty BOOK_LANGSCeri Davies2021-07-221-0/+2
|
* documentation/Makefile: Add HTML targets for offline useMarc Fonvieille2021-07-141-24/+174
| | | | | | | | | | | | | Addition of various HTML targets allowing the build of books, articles with the choice of the language. For example, to build both en_US and fr_FR books, use: make DOC_LANG="en fr" html-books Documents are installed in documentation/public/lang/. Targets to clean the builds are also available. The produced files do not include some metadatas, they are intended for offline use. Reviewed by: ceri Differential Revision: https://reviews.freebsd.org/D30718
* documentation/Makefile: For PDF versions, only build requested languages.Marc Fonvieille2021-07-051-1/+1
|
* Makefile: If DOC_LANG is set, stop hugo from building other languages.Ceri Davies2021-06-301-3/+24
| | | | | | | | | | | | The hugo driven targets currently build all the languages despite anything set in DOC_LANG or elsewhere. Have DOC_LANG drive HUGO_DISABLELANGUAGES in order to stop that. With the caveat that: hugo always has to build en as it's the default language, so add a warning if it's left out before adding it back in. Reviewed by: dbaio, ygy Differential Revision: https://reviews.freebsd.org/D30796
* Add a "clean" target.Ceri Davies2021-06-291-4/+20
| | | | | Reviewed by: ygy Differential Revision: https://reviews.freebsd.org/D30925
* documentation/Makefile: use all languages by defaultCeri Davies2021-06-161-8/+18
| | | | | | | | | | | | | | Previously we only added languages with content in books/ to the LANGUAGES variable because they would cause the build to fail, and this meant that they did not get PDFs built either. It also meant they could not be included in DOC_LANG as this then break the build. Add a new variable, ARTICLEONLY_LANGS, to identify them and, with the safety of the new logic in the tools/book-toc*py scripts to warn if we miss one, build all of the content by default under the PDF target. This also makes DOC_LANG safe to use even if there isn't a book in that language.
* hugo server: Fix bind and hostname parametersDanilo G. Baio2021-06-081-2/+6
| | | | | | | | | When BIND variable is defined, baseURL/.HOST should not be set to localhost by default. Reported by: imp Reviewed by: imp, ceri, blackend Differential Revision: https://reviews.freebsd.org/D30656
* Add support to Hugo arguments/flagsDanilo G. Baio2021-06-051-2/+3
| | | | | | | | | This also enables verbose output by default, same behavior we had in the doc tree before Hugo/Asciidoctor and add --minify to HUGO_ARGS variable to make it optional. Reviewed by: ceri, allanjude, imp Differential Revision: https://reviews.freebsd.org/D30652
* documentation/Makefile: un-.PHONY generate-pgpkeys-txt targetCeri Davies2021-06-011-1/+3
| | | | Approved by: blackend (mentor)
* documentation/Makefile: update lead-in note on common targetsCeri Davies2021-06-011-1/+2
| | | | Approved by: blackend (mentor)
* documentation/Makefile: Use of ${LOCALBASE} where needed.Marc Fonvieille2021-05-311-1/+1
| | | | Reported by: ceri
* documentation/Makefile: Add PDF targets.Marc Fonvieille2021-05-311-0/+132
| | | | | | | | | | | | Addition of various PDF targets allowing the build of books, articles with the choice of the language. For example, to build both en_US and fr_FR books, use: make DOC_LANG="en,fr" pdf-books Documents are installed in documentation/public/lang/. Targets to clean the builds are also available. Reviewed by: ceri, gjb, dbaio Differential Revision: <https://reviews.freebsd.org/D30331>
* Add new tool to generate the pgpkeys.txt fileSergio Carlavilla Delgado2021-05-161-2/+6
|
* documentation/Makefile: add requirements targetSofian Brabez2021-05-131-4/+19
| | | | | | | | | Add the requirements target in order to prompt the user to install the needed dependencies to be able to run `make run` successfully. Reviewed by: ygy, debdrup, imp Approved by: ygy (doc) Differential Revision: https://reviews.freebsd.org/D30161
* Allow binding to something else than 127.0.0.1.Mathieu Arnold2021-04-121-1/+1
| | | | | | | If not building the documentation on your local machine, you may need to access the hugo server from another machine, you may want to run: make run HOSTNAME=host.example.org BIND=::
* Allow building the documentation and the website with upstream hugoSergio Carlavilla Delgado2021-03-311-0/+2
| | | | | | | | | | | | | | | | | | | | | | | 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
* Makefiles and FDP: Change python binaryYasuhiro Kimura2021-02-161-1/+1
| | | | | | | | | | | | | | | | | | | 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.
* Makefiles: Add a conditional check on HOSTNAME variableDaniel Ebdrup Jensen2021-02-141-1/+7
| | | | | | | | | | | | In order for hugo to build all links correctly, it is necessary to define baseURL - but in order to do this, we need some way of adding a hostname. This change adds the HOSTNAME variable to accomplish this. Another advantage is that if HOSTNAME is set to something other than localhost, hugo can be run on a different (more powerful) machine which can shorten the time it takes to build. A note about this will need to be added to the FDP later.
* Restore the generation of the TOCs in the MakefileSergio Carlavilla Delgado2021-02-131-1/+2
| | | | | Restore the generation of the TOCs in the Makefile when running make run
* build: remove generate target, split run outKyle Evans2021-01-291-3/+9
| | | | | | | | This ensures that `make all` will never try to run the internal server. Instead, the user can run it manually if they need to. Reviewed-by: gjb, hrs Differential-Revision: https://reviews.freebsd.org/D28384
* build: slap fake targets with .PHONYKyle Evans2021-01-291-5/+5
| | | | | | | | This instructs make(1) to consider them always out of date, and prevents foot-shooting if a directory entry with the same name comes into existence. Reviewed-by: gjb, hrs Differential-Revision: https://reviews.freebsd.org/D28383
* build: slap some .ORDER on targetsKyle Evans2021-01-291-0/+4
| | | | | | | | This ensures that the build still generally works if one specifies jobs and multiple targets at the same time. Reviewed-by: gjb, hrs Differential-Revision: https://reviews.freebsd.org/D28382
* build: replace move-shared/copy-shared with a symlinkKyle Evans2021-01-291-5/+0
| | | | | | | | The build should strive to not write to the shared space, so symlink these back to the one copy and remove the prep work needed. Reviewed-by: gjb, hrs Differential-Revision: https://reviews.freebsd.org/D28381
* Migrate doc to Hugo/AsciiDoctorSergio Carlavilla Delgado2021-01-251-0/+41
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
generated by cgit v1.2.3 (git 2.25.1) at 2026-03-02 16:13:07 +0000