Install all the documentation in to a single root, $WEBROOT/doc, with the
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
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
|
|
@ -1,11 +1,26 @@
|
|||
#
|
||||
# $FreeBSD: www/en/FAQ/Makefile,v 1.3 1999/09/06 07:02:39 peter Exp $
|
||||
# $FreeBSD: www/en/FAQ/Makefile,v 1.4 1999/09/15 20:37:03 wosch Exp $
|
||||
#
|
||||
# Build the FreeBSD FAQ *outside* of the www tree, and install it
|
||||
# in to the right place as necessary.
|
||||
|
||||
all install clean:
|
||||
(cd ../../../doc/en_US.ISO_8859-1/books/faq && ${MAKE} 'FORMATS=html-split html' DESTDIR=${DESTDIR}/data/FAQ ${.TARGET})
|
||||
.if make(install)
|
||||
(cd ${DESTDIR}/data/FAQ; ln -sf index.html FAQ.html)
|
||||
.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/faq/* .
|
||||
|
||||
# At install time the www/en/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/faq/* ${DOCINSTALLDIR})
|
||||
|
||||
.include "${WEB_PREFIX}/share/mk/web.site.mk"
|
||||
|
||||
|
|
|
|||
17
en/Makefile
17
en/Makefile
|
|
@ -1,4 +1,4 @@
|
|||
# $FreeBSD: www/en/Makefile,v 1.60 2001/02/24 10:31:28 wosch Exp $
|
||||
# $FreeBSD: www/en/Makefile,v 1.61 2001/02/25 12:00:49 alex Exp $
|
||||
.if exists(Makefile.conf)
|
||||
.include "Makefile.conf"
|
||||
.endif
|
||||
|
|
@ -31,6 +31,7 @@ DATA= robots.txt
|
|||
# SGML
|
||||
SUBDIR= security
|
||||
SUBDIR+= commercial
|
||||
SUBDIR+= doc
|
||||
SUBDIR+= docproj
|
||||
SUBDIR+= news
|
||||
SUBDIR+= alpha
|
||||
|
|
@ -48,6 +49,12 @@ SUBDIR+= conspectus
|
|||
SUBDIR+= ports
|
||||
.endif
|
||||
|
||||
# These *must* be listed after the "doc" subdir, as they create symlinks
|
||||
# in to it.
|
||||
SUBDIR+= FAQ
|
||||
SUBDIR+= handbook
|
||||
SUBDIR+= tutorials
|
||||
|
||||
# Non-SGML
|
||||
SUBDIR+= gifs
|
||||
SUBDIR+= cgi
|
||||
|
|
@ -58,16 +65,10 @@ WEB_LANG?= ja es ru zh de
|
|||
|
||||
.if !defined(ENGLISH_ONLY) || empty(ENGLISH_ONLY)
|
||||
.for DIR in ${WEB_LANG}
|
||||
SUBDIR+= ../${DIR}
|
||||
#SUBDIR+= ../${DIR}
|
||||
.endfor
|
||||
.endif
|
||||
|
||||
.if !defined(WEB_ONLY) || empty(WEB_ONLY)
|
||||
# Extern
|
||||
SUBDIR+= tutorials
|
||||
|
||||
DOCSUBDIR= FAQ handbook
|
||||
.endif
|
||||
SGMLOPTS+= -links -hdr ${.CURDIR}/doc.hdr -ftr ${.CURDIR}/doc.ftr
|
||||
|
||||
WEBDIR= data
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
#
|
||||
# $FreeBSD: www/en/docs/Makefile,v 1.2 2001/02/23 10:13:49 nik Exp $i
|
||||
# $FreeBSD: www/en/docs/Makefile,v 1.3 2001/02/24 18:04:10 nik Exp $i
|
||||
#
|
||||
# Build the FreeBSD documentation *outside* of the www tree, and install it
|
||||
# in to the right place as necessary.
|
||||
|
|
@ -10,4 +10,4 @@
|
|||
#
|
||||
|
||||
all install clean:
|
||||
(cd ../../../doc/en_US.ISO_8859-1 && unset DESTDIR || ${MAKE} FORMATS=html-split DOCDIR=${DESTDIR}/data/docs ${.TARGET})
|
||||
(unset DESTDIR || true; cd ${.CURDIR}/../../../doc/en_US.ISO_8859-1 && ${MAKE} FORMATS=html-split DOCDIR=${DESTDIR}/data/doc ${.TARGET})
|
||||
64
en/docs.sgml
64
en/docs.sgml
|
|
@ -1,9 +1,9 @@
|
|||
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" [
|
||||
<!ENTITY date "$FreeBSD: www/en/docs.sgml,v 1.92 2001/02/22 15:44:36 nik Exp $">
|
||||
<!ENTITY date "$FreeBSD: www/en/docs.sgml,v 1.93 2001/02/25 12:00:13 wosch Exp $">
|
||||
<!ENTITY title "Documentation">
|
||||
<!ENTITY % includes SYSTEM "includes.sgml"> %includes;
|
||||
]>
|
||||
<!-- $FreeBSD: www/en/docs.sgml,v 1.92 2001/02/22 15:44:36 nik Exp $ -->
|
||||
<!-- $FreeBSD: www/en/docs.sgml,v 1.93 2001/02/25 12:00:13 wosch Exp $ -->
|
||||
|
||||
<html>
|
||||
&header;
|
||||
|
|
@ -27,83 +27,89 @@
|
|||
|
||||
<h3>Books</h3>
|
||||
|
||||
<p><a href="docs/en/books/faq/index.html">The FreeBSD FAQ</a><br>
|
||||
<p><a href="doc/en_US.ISO_8859-1/books/faq/index.html">The FreeBSD
|
||||
FAQ</a><br>
|
||||
<small>Frequently Asked Questions, and answers, covering all
|
||||
aspects of FreeBSD.</small></p>
|
||||
|
||||
<p><a href="docs/en/books/handbook/index.html">The FreeBSD Handbook</a><br>
|
||||
<p><a href="doc/en_US.ISO_8859-1/books/handbook/index.html">The FreeBSD
|
||||
Handbook</a><br>
|
||||
<small>A constantly evolving, comprehensive resource for FreeBSD
|
||||
users.</small></p>
|
||||
|
||||
<p><a href="docs/en/books/design-44bsd/index.html">Chapter 2 of "The
|
||||
Design and Implementation of the 4.4BSD Operating System"</a><br>
|
||||
<p><a href="doc/en_US.ISO_8859-1/books/design-44bsd/index.html">Chapter 2
|
||||
of "The Design and Implementation of the 4.4BSD Operating
|
||||
System"</a><br>
|
||||
<small>Donated by Addison-Wesley, provides a design overview of 4.4BSD,
|
||||
from which FreeBSD was originally derived.</small></p>
|
||||
|
||||
<p><a href="docs/en/books/ppp-primer/index.html">The Pedantic PPP
|
||||
Primer</a><br>
|
||||
<p><a href="doc/en_US.ISO_8859-1/books/ppp-primer/index.html">The Pedantic
|
||||
PPP Primer</a><br>
|
||||
<small>Everything you need to know about configuring PPP on
|
||||
FreeBSD.</small></p>
|
||||
|
||||
<p><a href="docs/en/books/porters-handbook">The Porter's Handbook</a><br>
|
||||
<p><a href="doc/en_US.ISO_8859-1/books/porters-handbook">The Porter's
|
||||
Handbook</a><br>
|
||||
<small>Essential reading if you plan on providing a port of a third
|
||||
party piece of software.</small></p>
|
||||
|
||||
<p><a href="docs/en/books/fdp-primer">The FreeBSD Documentation Project
|
||||
Primer for New Contributors</a><br>
|
||||
<p><a href="doc/en_US.ISO_8859-1/books/fdp-primer">The FreeBSD
|
||||
Documentation Project Primer for New Contributors</a><br>
|
||||
<small>Everything you need to know in order to start contributing to the
|
||||
FreeBSD Documentation Project.</small></p>
|
||||
|
||||
<h3>Articles</h3>
|
||||
|
||||
<p><a href="docs/en/articles/committers-guide/index.html">The Committer's
|
||||
Guide</a><br>
|
||||
<p><a href="doc/en_US.ISO_8859-1/articles/committers-guide/index.html">The
|
||||
Committer's Guide</a><br>
|
||||
<small>Introductory information for FreeBSD committers.</small></p>
|
||||
|
||||
<p><a href="docs/en/articles/dialup-firewall/index.html">Dialup
|
||||
<p><a href="doc/en_US.ISO_8859-1/articles/dialup-firewall/index.html">Dialup
|
||||
firewalling with FreeBSD</a><br>
|
||||
<small>How to set up a firewall using PPP and ipfw over a dialup link
|
||||
with dynamically assigned IP addresses.</small></p>
|
||||
|
||||
<p><a href="docs/en/articles/diskless-x/index.html">Creating a diskless X
|
||||
server</a><br>
|
||||
<p><a href="doc/en_US.ISO_8859-1/articles/diskless-x/index.html">Creating
|
||||
a diskless X server</a><br>
|
||||
<small>How to create a diskless X server.</small></p>
|
||||
|
||||
<p><a href="docs/en/articles/fonts/index.html">Fonts and FreeBSD</a><br>
|
||||
<p><a href="doc/en_US.ISO_8859-1/articles/fonts/index.html">Fonts and
|
||||
FreeBSD</a><br>
|
||||
<small>A description of the various font technologies in FreeBSD, and
|
||||
how to use them with different programs.</small></p>
|
||||
|
||||
<p><a href="docs/en/articles/formatting-media/index.html">Formatting media
|
||||
on FreeBSD</a><br>
|
||||
<p><a href="doc/en_US.ISO_8859-1/articles/formatting-media/index.html">Formatting
|
||||
media on FreeBSD</a><br>
|
||||
<small>How to slice, partition, and format fixed and removable media on
|
||||
FreeBSD.</small></p>
|
||||
|
||||
<p><a href="docs/en/articles/freebsd-questions/index.html">How to get the
|
||||
best results from the FreeBSD-questions mailing list</a><br>
|
||||
<p><a href="doc/en_US.ISO_8859-1/articles/freebsd-questions/index.html">How
|
||||
to get the best results from the FreeBSD-questions mailing list</a><br>
|
||||
<small>Tips and tricks to help you maximise the chances of getting
|
||||
useful information from the -questions mailing list.</small></p>
|
||||
|
||||
<p><a href="docs/en/articles/mh/index.html">An MH Primer</a><br>
|
||||
<p><a href="doc/en_US.ISO_8859-1/articles/mh/index.html">An MH
|
||||
Primer</a><br>
|
||||
<small>An introduction to using the MH mail reader on
|
||||
FreeBSD.</small></p>
|
||||
|
||||
<p><a href="docs/en/articles/multi-os/index.html">Using FreeBSD with other
|
||||
operating systems</a><br>
|
||||
<p><a href="doc/en_US.ISO_8859-1/articles/multi-os/index.html">Using
|
||||
FreeBSD with other operating systems</a><br>
|
||||
<small>How to install FreeBSD alongside one or more different operating
|
||||
systems on the same computer.</small></p>
|
||||
|
||||
<p><a href="docs/en/articles/new-users/index.html">FreeBSD First
|
||||
Steps</a><br>
|
||||
<p><a href="doc/en_US.ISO_8859-1/articles/new-users/index.html">FreeBSD
|
||||
First Steps</a><br>
|
||||
<small>For people coming to FreeBSD and Unix for the first
|
||||
time.</small></p>
|
||||
|
||||
<p><a href="docs/en/articles/programming-tools/index.html">Programming
|
||||
<p><a href="doc/en_US.ISO_8859-1/articles/programming-tools/index.html">Programming
|
||||
Tools on FreeBSD</a><br>
|
||||
<small>A user's guide to the various tools for software development on
|
||||
FreeBSD.</small></p>
|
||||
|
||||
<p><a href="docs/en/articles/zip-drive/index.html">Zip-drives and
|
||||
FreeBSD</a><br>
|
||||
<p><a href="doc/en_US.ISO_8859-1/articles/zip-drive/index.html">Zip-drives
|
||||
and FreeBSD</a><br>
|
||||
<small>How to format, mount, and use an Iomega Zip (SCSI, IDE, or
|
||||
parallel) Drive on FreeBSD.</small></p>
|
||||
|
||||
|
|
|
|||
|
|
@ -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"
|
||||
|
||||
|
|
|
|||
Loading…
Reference in a new issue