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

Install all the documentation in to a single root, $WEBROOT/doc, with the

Browse source 
same naming scheme as that used by the doc/ repo.

Update docs.sgml to point to the documentation in this canonical location.

Update the FAQ/ and handbook/ directories to use symlinks to point to
the real documentation under doc/en_US.ISO_8859-1/.  This means that local
testing of the site (and mirrors) will still work as expected using the
legacy URLs.  Mirrors that expect to see a lot of traffic are advised to
alter their web server configuration so that $WEBROOT/FAQ and $WEBROOT/handbook
are redirected to $WEBROOT/doc/en_US.ISO_8859-1/books/{faq,handbook},
instead of relying on the symlinks.

Discussed on:	doc, www
This commit is contained in:
Nik Clayton 2001-04-17 09:05:43 +00:00
parent 5a16245baf
commit eab69689b8
Notes: svn2git 2020-12-08 03:00:23 +00:00 
svn path=/www/; revision=9212
5 changed files with 87 additions and 59 deletions
Download patch file Download diff file Expand all files Collapse all files

36
en/handbook/Makefile
View file

@ -1,18 +1,24 @@
#
# $FreeBSD: www/en/handbook/Makefile,v 1.4 1999/09/06 07:02:45 peter Exp $
#
# Build the FreeBSD Handbook *outside* of the www tree, and install it
# in to the right place as necessary.
#
# The Handbook is no longer completely self contained in
# doc/en_US.ISO_8859-1/books/handbook, (it requires support files outside of
# this directory) and it is much simpler to build it outside the web tree
# than it is to make a nest of symlinks to try and build it inside the tree.
#
# This assumes that you have the www/ and doc/ trees checked out beside
# one another -- this was always the case anyway, so there are no extra
# requirements here.
# $FreeBSD: www/en/FAQ/Makefile,v 1.4 1999/09/15 20:37:03 wosch Exp $
#
all install clean:
(cd ../../../doc/en_US.ISO_8859-1/books/handbook && ${MAKE} FORMATS=html-split DESTDIR=${DESTDIR}/data/handbook ${.TARGET})
.if exists(../Makefile.conf)
.include "../Makefile.conf"
.endif
.if exists(../Makefile.inc)
.include "../Makefile.inc"
.endif
# At build time, we have to link to the doc/ directory at the same level
# as the www/ tree.
all:
ln -fs ${.CURDIR}/../../../doc/en_US.ISO_8859-1/books/handbook/* .
# At install time the ../doc/ directory has been populated, so we can
# link in to there instead.
install:
[ -d ${DOCINSTALLDIR} ] || mkdir ${DOCINSTALLDIR}
(cd ${DOCINSTALLDIR} && ln -fs ../doc/en_US.ISO_8859-1/books/handbook/* ${DOCINSTALLDIR})
.include "${WEB_PREFIX}/share/mk/web.site.mk"