Skip site navigation (1)Skip section navigation (2)
Date:      Mon, 7 Jun 1999 23:32:28 +0100
From:      Nik Clayton <nik@nothing-going-on.demon.co.uk>
To:        Jun Kuriyama <kuriyama@sky.rim.or.jp>
Cc:        doc@freebsd.org, freebsd-translate@ngo.org.uk
Subject:   Re: FDP Directory Reorganisation
Message-ID:  <19990607233227.A34938@catkin.nothing-going-on.org>
In-Reply-To: <37593369.10E2888D@sky.rim.or.jp>; from Jun Kuriyama on Sat, Jun 05, 1999 at 11:25:45PM %2B0900
References:  <19990513211458.B70767@catkin.nothing-going-on.org> <19990603195027.A31941@catkin.nothing-going-on.org> <37593369.10E2888D@sky.rim.or.jp>

next in thread | previous in thread | raw e-mail | index | archive | help
On Sat, Jun 05, 1999 at 11:25:45PM +0900, Jun Kuriyama wrote:
> Nik Clayton wrote:
> > I haven't been sleeping on this.  The CVS Repository maintainers (Peter
> > Wemm and John Polstra) are both too busy to deal with the changes
> > required at the moment.  According to John the week beginning the 14th June
> > is the earliest they will get to it.
> 
> Can you summarize changes on this re-organization?

Here's the message I sent Peter and John;

N

[ This is a draft, please don't make any of these changes yet.  Could you
  look over it and let me know if any of this causes you problems.

  Thanks -- N ]

Can you make a largeish change to the doc/ repository for me please.  We're
reorganising the directory structure to make it a little more scaleable for
new translations of the FreeBSD documentation, and it's best to do this now
while the impact is relatively minor.

Please;

1.  Update the "avail" file so that only I can commit to the doc/
    repository.

2.  Fixup the English hierarchy;

    2.1  Move doc/en/ to doc/en_US.ISO_8859-1/.

    2.2  Create a new doc/en_US.ISO_8859-1/books/ directory.

    2.3  Move the doc/en_US.ISO_8859-1/handbook/ directory under the new
         books/ directory, so you now have
	 doc/en_US.ISO_8859-1/books/handbook/.

         Please rename "handbook.sgml" in this directory to "book.sgml".

    2.4  Move the doc/en_US.ISO_8859-1/tutorials/docproj-primer/ directory
         under the new books/ directory, and call it fdp-primer/ instead,
	 so you now have doc/en_US.ISO_8859-1/books/fdp-primer/.

    2.5  Create a new doc/en_US.ISO_8859-1/articles/ directory.
    	 
    2.6  Move the doc/en_US.ISO_8859-1/tutorials/devel/ directory to
         the new .../articles/ directory, and rename the directory to
	 "programming-tools".  So the complete directory name is
	 doc/en_US.ISO_8859-1/articles/programming-tools/.

         Rename "devel.docb" in this directory to "article.sgml".

    2.7  Repeat the steps in 2.6, but for the .../tutorials/diskformat/
         directory.  Please rename this directory to "formatting-media"
	 so the complete directory name is
	 doc/en_US.ISO_8859-1/articles/formatting-media/.

         Rename "diskformat.docb" in this directory to "article.sgml".

    2.8  Repeat the steps in 2.6, but for the .../tutorials/disklessx/
         directory.  Please rename this directory to "diskless-x-server" so
	 the complete directory name is
	 doc/en_US.ISO_8859-1/articles/diskless-x-server/.

	 Rename "disklessx.docb" in this directory to "article.sgml".

    2.9  Repeat the steps in 2.6, but for the .../tutorials/fonts/ directory.
         You do not need to rename this directory, so the complete directory
	 name is doc/en_US.ISO_8859-1/articles/fonts/.

	 Rename "fonts.docb" in this directory to "article.sgml".

    2.10 Repeat the steps in 2.6, but for the .../tutorials/mh/ directory.
         You do not need to rename this directory, so the complete directory
	 name is doc/en_US.ISO_8859-1/articles/mh/.

	 Rename "mh.docb" in this directory to "article.sgml".

    2.11 Repeat the steps in 2.6, but for the .../tutorials/multios/
         directory.  Please rename this directory to "multi-os" so the
	 complete directory name is doc/en_US.ISO-8859-1/articles/multi-os/.

	 Rename "multios.docb" in this directory to "article.sgml".

    2.12 Repeat the steps in 2.6, but for the .../tutorials/newuser/
         directory.  Please rename this directory to "new-users" so the
	 complete directory name is doc/en_US.ISO_8859-1/articles/new-users/.

	 Rename "newuser.docb" in this directory to "article.sgml".

    2.13 Please leave the tutorials/ddwg and tutorials/ppp directories.  These
         documents are still marked up in LinuxDoc DTD, and I will migrate
	 them over to DocBook after this repository change.

    2.14 At the end of this, the directory hierarchy for the English
         documentation should look like

	 doc
	  |-- FAQ
	  `-- en_US.ISO_8859-1
	  :    |-- articles
	  :    |    |-- diskless-x-server
	  :    |    |-- fonts
	       |    |-- formatting-media
	       |    |-- mh
	       |    |-- multi-os
	       |    |-- new-users
	       |    `-- programming-tools
	       |-- books
	       |    |-- handbook
   	       |    `-- fdp-primer
	       |-- share
               `-- tutorials
	            |-- ddwg
		    `-- ppp

          Note that you have done nothing with the contents of the share/
	  directory.		    
    
3.  Fixup the Spanish hierarchy.

    3.1  Move doc/es to doc/es_ES.ISO-8859-1/.

    3.2  Leave the FAQ where it is, as it hasn't been converted to DocBook
         yet.

    3.3  The Spanish directory hierarchy should look like

         doc
	  `-- es_ES.ISO_8859-1
	  :    `-- FAQ
	  :
	  :

4.  Fixup the Japanese hierarchy.

    4.1  Move doc/ja/ to doc/ja_JP.EUC/.  Note that an old directory with this
         name (but with the contents in the attic) already exists.  I'm not
	 sure if this poses a problem or not.

    4.2  Create a new doc/ja_JP.EUC/books/ directory.

    4.3  Move the doc/ja_JP.EUC/handbook/ directory under the new books/
         directory, so you now have doc/ja_JP.EUC/books/handbook/.

         Rename "handbook.sgml" to "book.sgml".

    4.4  Leave the FAQ where it is, as it hasn't been converted to DocBook
         yet.

    4.5  The Japanese directory hierarchy should look like

         doc
	  `-- ja_JP.EUC
	  :    |-- books
	  :    |    `-- handbook
	  :    |-- FAQ
	       `-- man

5.  Fixup the Russian hierarchy

    5.1  Move doc/ru/ to doc/ru_SU.KOI8-R/.

    5.2  Leave the FAQ where it is, as it hasn't been converted to DocBook
         yet.

    5.3  The Russian directory hierarchy should look like

         doc
	  `-- ru_SU.KOI8-R
	  :    `-- FAQ
	  :
	  :

6.  Fixup the Chinese hierarchy

    5.1  Move doc/zh/ to doc/zh_TW.BIG5/.

    5.2  Leave the FAQ where it is, as it hasn't been converted to DocBook
         yet.

    5.3  The Chinese directory hierarchy should look like

         doc
	  `-- zh_TW.BIG5
	  :    `-- FAQ
	  :
	  :	         

When this has been done, I'll synchronise my local copy of the tree with the
new version, and then commit new Makefiles that reflect the new directory
structure.  Once everything's tested and working again, I'll update the
"avail" file so that everyone else can commit back to doc/.

Thanks,

N <nik@freebsd.org>

-- 
 [intentional self-reference] can be easily accommodated using a blessed,
 non-self-referential dummy head-node whose own object destructor severs
 the links.
    -- Tom Christiansen in <375143b5@cs.colorado.edu>


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




Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?19990607233227.A34938>