summaryrefslogtreecommitdiff
path: root/docutils/docs/dev
diff options
context:
space:
mode:
authormilde <milde@929543f6-e4f2-0310-98a6-ba3bd3dd1d04>2009-04-06 08:52:24 +0000
committermilde <milde@929543f6-e4f2-0310-98a6-ba3bd3dd1d04>2009-04-06 08:52:24 +0000
commit24d6f49d1690b7638d075d9ac505ad4e7d7a90f2 (patch)
treeb11bca652f416c913f3538cae5506ed6578d5706 /docutils/docs/dev
parentfcec731313ec2711ede1f0b00a4eacf1da1e1dd6 (diff)
downloaddocutils-24d6f49d1690b7638d075d9ac505ad4e7d7a90f2.tar.gz
revision of website instructions
git-svn-id: http://svn.code.sf.net/p/docutils/code/trunk@5899 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
Diffstat (limited to 'docutils/docs/dev')
-rw-r--r--docutils/docs/dev/website.txt72
1 files changed, 30 insertions, 42 deletions
diff --git a/docutils/docs/dev/website.txt b/docutils/docs/dev/website.txt
index fdd4719ee..b2116d270 100644
--- a/docutils/docs/dev/website.txt
+++ b/docutils/docs/dev/website.txt
@@ -12,8 +12,7 @@ The Docutils web site, <http://docutils.sourceforge.net/>, is
maintained by the ``docutils-update.local`` script, run by project
maintainers on their local machines. The script
will process any .txt file which is newer than the corresponding .html
-file in the project's web directory on shell.berlios.de
-(``/home/groups/docutils/htdocs/aux/htdocs/``) and upload the changes
+file in the local copy of the project's web directory and upload the changes
to the web site at SourceForge.
.. .. old instructions, for cron job:
@@ -49,65 +48,54 @@ Setting Up
(TBA)
+.. hint::
+ Anyone with checkin privileges can be a web-site maintainer. You need to
+ set up the directories for a local website build.
-.. .. not needed if one just adds the .html files to the list
- Only the maintainer has to keep this in mind (until the
- update-htmlfiles script is incorporated into
- docutils-update.local)
-
- Adding Directories
- ==================
-
- After adding directories to SVN, allow the update script to run once
- to create the directories in the filesystem before preparing for HTML
- processing as described below.
+ The procedure for that was on the docutils-devel list a while ago.
Adding .txt Files
=================
-When adding a new .txt file that should be converted to HTML:
-
-* Edit sandbox/infrastructure/htmlfiles.lst, and add the .html file
- corresponding to the new .txt file (please keep the sorted order).
-
-* Commit the edited version to the SVN repository.
+User/Contributor
+----------------
-.. .. instructions for the maintainer:
+When adding a new .txt file that should be converted to HTML:
- Run the sandbox/infrastructure/update-htmlfiles shell script to
- generate .html files::
+#. Edit sandbox/infrastructure/htmlfiles.lst, and add the .html file
+ corresponding to the new .txt file (please keep the sorted order).
- cd <DOCUTILS-ROOT>/docutils/
- sandbox/infrastructure/update-htmlfiles sandbox/infrastructure/htmlfiles.lst
+#. Commit the edited version to the SVN repository.
- Maybe this should become part of docutils-update.local.
+Maintainer
+----------
-.. .. old instructions, for cron job:
+#. If there are new directories in the SVN, allow the update script to run
+ once to create the directories in the filesystem before preparing for
+ HTML processing.
- For a new .txt file, just SSH to ``<username>@shell.berlios.de`` and
- ::
+#. Run the sandbox/infrastructure/update-htmlfiles shell script to generate
+ .html files::
- cd /home/groups/docutils/htdocs/aux/htdocs/
- cd [path to your file's subdirectory]
- touch filename.html
- chmod g+w filename.html
- sleep 1
- touch filename.txt
+ cd <DOCUTILS-ROOT>/docutils/
+ sandbox/infrastructure/update-htmlfiles \
+ sandbox/infrastructure/htmlfiles.lst
- The script will take care of the rest within an hour. Thereafter
- whenever the .txt file is modified (checked in to SVN), the .html will
- be regenerated automatically.
+ (Maybe this should become part of docutils-update.local.)
Removing Files & Directories
============================
-Removing files and directories from SVN will not trigger their removal
-from the web site. Files and directories must be manually removed
-from sourceforge.net
-(under ``/home/groups/d/do/docutils/htdocs/``). Also remove the files
-from sandbox/infrastructure/htmlfiles.lst.
+#. Remove from SVN
+
+#. Remove to-be-generated HTML files from
+ ``sandbox/infrastructure/htmlfiles.lst``.
+
+#. Removing files and directories from SVN will not trigger their removal
+ from the web site. Files and directories must be manually removed from
+ sourceforge.net (under ``/home/groups/d/do/docutils/htdocs/``).
..