docs/dev/website.txt

   1 ===================
   2  Docutils Web Site
   3 ===================
   4
   5 :Author: David Goodger; open to all Docutils developers
   6 :Contact: docutils-develop@lists.sourceforge.net
   7 :Date: $Date$
   8 :Revision: $Revision$
   9 :Copyright: This document has been placed in the public domain.
  10
  11 The Docutils web site, <http://docutils.sourceforge.net/>, is
  12 maintained by the ``docutils-update.local`` script, run by project
  13 maintainers on their local machines.  The script
  14 will process any .txt file which is newer than the corresponding .html
  15 file in the local copy of the project's web directory and upload the changes
  16 to the web site at SourceForge.
  17
  18 ..  .. old instructions, for cron job:
  19
  20     The Docutils web site, <http://docutils.sourceforge.net/>, is
  21     maintained automatically by the ``docutils-update`` script, run as an
  22     hourly cron job on shell.berlios.de (by user "wiemann").  The script
  23     will process any .txt file which is newer than the corresponding .html
  24     file in the project's web directory on shell.berlios.de
  25     (``/home/groups/docutils/htdocs/aux/htdocs/``) and upload the changes
  26     to the web site at SourceForge.
  27
  28 Please **do not** add any generated .html files to the Docutils
  29 repository.  They will be generated automatically after a one-time
  30 setup (`described below`__).
  31
  32 __ `Adding .txt Files`_
  33
  34 The docutils-update.local__ script is located at
  35 ``sandbox/infrastructure/docutils-update.local``.
  36
  37 __ http://docutils.sf.net/sandbox/infrastructure/docutils-update.local
  38
  39 If you want to share files via the web, you can upload them using the
  40 uploaddocutils.sh__ script
  41 (``sandbox/infrastructure/uploaddocutils.sh``).
  42
  43 __ http://docutils.sf.net/sandbox/infrastructure/uploaddocutils.sh
  44
  45
  46 Setting Up
  47 ==========
  48
  49 (TBA)
  50
  51 .. hint::
  52   Anyone with checkin privileges can be a web-site maintainer. You need to
  53   set up the directories for a local website build.
  54
  55   The procedure for that was on the docutils-devel list a while ago.
  56
  57
  58 Adding .txt Files
  59 =================
  60
  61 User/Contributor
  62 ----------------
  63
  64 When adding a new .txt file that should be converted to HTML:
  65
  66 #. Edit sandbox/infrastructure/htmlfiles.lst, and add the .html file
  67    corresponding to the new .txt file (please keep the sorted order).
  68
  69 #. Commit the edited version to the SVN repository.
  70
  71 Maintainer
  72 ----------
  73
  74 #. If there are new directories in the SVN, allow the update script to run
  75    once to create the directories in the filesystem before preparing for
  76    HTML processing.
  77
  78 #. Run the sandbox/infrastructure/update-htmlfiles shell script to generate
  79    .html files::
  80
  81       cd <DOCUTILS-ROOT>/docutils/
  82       sandbox/infrastructure/update-htmlfiles \
  83       sandbox/infrastructure/htmlfiles.lst
  84
  85    (Maybe this should become part of docutils-update.local.)
  86
  87
  88 Removing Files & Directories
  89 ============================
  90
  91 #. Remove from SVN
  92
  93 #. Remove to-be-generated HTML files from
  94    ``sandbox/infrastructure/htmlfiles.lst``.
  95
  96 #. Removing files and directories from SVN will not trigger their removal
  97    from the web site.  Files and directories must be manually removed from
  98    sourceforge.net (under ``/home/project-web/docutils/htdocs/``).
  99
 100 \f
 101 ..
 102    Local Variables:
 103    mode: indented-text
 104    indent-tabs-mode: nil
 105    sentence-end-double-space: t
 106    fill-column: 70
 107    End: