os/doc
3
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity
doc/website/Makefile

49 lines
1.4 KiB
Makefile
Raw Normal View History

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
# Generate the FreeBSD website
#
# Copyright (c) 2020-2021, The FreeBSD Documentation Project
# Copyright (c) 2020-2021, Sergio Carlavilla <carlavilla@FreeBSD.org>
#
# Targets intended for use on the command line
#
# all (default) - generate the releases.toml and compile all the website
build: remove generate target, split run out 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
2021-01-28 05:22:48 +01:00
# run - serves the built website for local browsing
#
# The run target uses hugo's built-in webserver to make the built website
# available for local browsing. The website should have been built prior
# to attempting to use the `run` target. By default, hugo will start its
# webserver on port 1313.
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
MAINTAINER=carlavilla@FreeBSD.org
PYTHON_CMD = /usr/local/bin/python3.7
HUGO_CMD = /usr/local/bin/hugo
Makefiles: Add a conditional check on HOSTNAME variable 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.
2021-02-14 22:39:20 +01:00
.ifndef HOSTNAME
.HOST+=localhost
.else
.HOST+=$(HOSTNAME)
.endif
build: remove generate target, split run out 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
2021-01-28 05:22:48 +01:00
.ORDER: all run
build: website: fix bogus .ORDER The website build doesn't have generate-books-toc, this should have been generate-releases. Pointy-hat: kevans
2021-01-29 04:51:18 +01:00
.ORDER: starting-message generate-releases
build: slap some .ORDER on targets 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
2021-01-27 17:05:58 +01:00
.ORDER: starting-message build
build: website: fix bogus .ORDER The website build doesn't have generate-books-toc, this should have been generate-releases. Pointy-hat: kevans
2021-01-29 04:51:18 +01:00
.ORDER: generate-releases build
build: slap some .ORDER on targets 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
2021-01-27 17:05:58 +01:00
build: remove generate target, split run out 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
2021-01-28 05:22:48 +01:00
all: starting-message generate-releases build
Restore the generation of releases.toml when running make run
2021-02-13 20:04:10 +01:00
run: starting-message generate-releases run-local
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
build: slap fake targets with .PHONY 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
2021-01-27 17:09:02 +01:00
starting-message: .PHONY
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
@echo ---------------------------------------------------------------
@echo Building the website
@echo ---------------------------------------------------------------
build: slap fake targets with .PHONY 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
2021-01-27 17:09:02 +01:00
generate-releases: .PHONY
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
${PYTHON_CMD} ./tools/releases-toml.py -p ./shared/releases.adoc
Restore the generation of releases.toml when running make run
2021-02-13 20:04:10 +01:00
run-local: .PHONY
Makefiles: Add a conditional check on HOSTNAME variable 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.
2021-02-14 22:39:20 +01:00
${HUGO_CMD} server -D --baseURL="http://$(.HOST):1313"
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
build: slap fake targets with .PHONY 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
2021-01-27 17:09:02 +01:00
build: .PHONY
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
${HUGO_CMD}
Reference in a new issue Copy permalink