From owner-freebsd-doc  Tue Mar 21  9:32:48 2000
Delivered-To: freebsd-doc@freebsd.org
Received: from nothing-going-on.demon.co.uk (nothing-going-on.demon.co.uk [193.237.89.66])
	by hub.freebsd.org (Postfix) with ESMTP id D92F937C086
	for <doc@freebsd.org>; Tue, 21 Mar 2000 09:32:24 -0800 (PST)
	(envelope-from nik@nothing-going-on.demon.co.uk)
Received: from kilt.nothing-going-on.org (kilt.nothing-going-on.org [192.168.1.18])
	by nothing-going-on.demon.co.uk (8.9.3/8.9.3) with ESMTP id QAA97000
	for <doc@freebsd.org>; Tue, 21 Mar 2000 16:47:13 GMT
	(envelope-from nik@catkin.nothing-going-on.org)
Received: (from nik@localhost)
	by kilt.nothing-going-on.org (8.9.3/8.9.3) id LAA26460
	for doc@freebsd.org; Tue, 21 Mar 2000 11:30:58 GMT
	(envelope-from nik@catkin.nothing-going-on.org)
Date: Tue, 21 Mar 2000 11:30:58 +0000
From: Nik Clayton <nik@freebsd.org>
To: doc@freebsd.org
Subject: $DIR/$DIR.sgml -> $DIR/index.sgml
Message-ID: <20000321113058.B26424@kilt.nothing-going-on.org>
Mime-Version: 1.0
Content-Type: text/plain; charset=us-ascii
X-Mailer: Mutt 0.95.4i
Organization: FreeBSD Project <URL:http://www.freebsd.org/>
Sender: owner-freebsd-doc@FreeBSD.ORG
Precedence: bulk
X-Loop: FreeBSD.org

Hi folks,

Comments please, before I ask the CVS-meisters to do the copy:

A glance at the web site will show that we have a mix and match of 
'index' file names.

[  An "index" file in this context means the "master" file for each 
   section of the web site.  For example, the index file for the java
   section is java/index.sgml, for the Doc. Proj section it's
   docproj/docproj.sgml, for the news section it's news/news.sgml, for
   the releases it's releases/index.sgml, and so on ]

Sometimes we use $DIR/$DIR.sgml, other times we use $DIR/index.sgml.

I'd like to suggest that 

  1.  From now on, we always use $DIR/index.sgml

  2.  The repo-meisters copy $DIR/$DIR.sgml to $DIR/index.sgml where
      that's not the case, and I'll patch up the Makefiles as necessary.

This will

  1.  Make the web site structure more consistent, which means there are
      fewer rules to carry around in your head when working on it.

  2.  Bring it more in to line with every other website I've ever worked
      on.

  3.  Allow Apache DirectoryIndex directives to work properly, allowing 
      us to quote URLs of the form .../news/, or .../docproj/.

Ultimately, I'd like a structure whereby each major section in the site
has an "obvious" name: alpha, java, ports, news, ... with an index.sgml
file in each one, containing pointers to all the appropriate information
for that section.

N
-- 
Internet connection, $19.95 a month.  Computer, $799.95.  Modem, $149.95.
Telephone line, $24.95 a month.  Software, free.  USENET transmission,
hundreds if not thousands of dollars.  Thinking before posting, priceless.
Somethings in life you can't buy.  For everything else, there's MasterCard.
  -- Graham Reed, in the Scary Devil Monastery


To Unsubscribe: send mail to majordomo@FreeBSD.org
with "unsubscribe freebsd-doc" in the body of the message