i've created a patch for jakarta-site2.xml which i hope should make things
a little clearer. i've made the headers for the instructions about
creating web pages for a project using anakia into subsections rather than
sections and grouped them together under a single section. i've moved the
section about how to modify the main (jakarta-site2) site pages above them.
i've added a section describing how to go about modifying the web pages
for a project which uses the standard method (ie anakia). this section is
based around peter and scott comments (thanks, guys).
i've included the patch and the generated html (since the moved text makes
the patch hard to read).
are these changes any good?
- robert
Index: xdocs/site/jakarta-site2.xml
===
RCS file: /home/cvs/jakarta-site2/xdocs/site/jakarta-site2.xml,v
retrieving revision 1.12
diff -u -r1.12 jakarta-site2.xml
--- xdocs/site/jakarta-site2.xml12 Jul 2001 16:32:15 - 1.12
+++ xdocs/site/jakarta-site2.xml15 Jan 2002 19:51:19 -
@@ -41,70 +41,101 @@
/p
/section
- section name=Using the jakarta-site2 module as a dependency
+section name=Modification of the Main Site Web Pages
p
-If you would like to use the jakarta-site2 module as a dependency for
-your project, here are the instructions for how to do that. The benefit
-of using it as a dependency is that you will be able to easily adopt the
-look and feel of the entire Jakarta website while being able to continue
-to have control over your own project's documentation navigation. It is
-the recommended, but optional way to develop documentation for projects
-hosted under the main Jakarta Project.
+People who have accounts on apache.org can check in their changes to the
+jakarta-site2 module directly. If you get an error such as Access
+denied: Insufficient Karma, then please send email to the
[EMAIL PROTECTED] mailing list and we will grant you the
+appropriate access. If you do not have an account, then please feel free
+to send patches (strongagainst the .xml files and not the .html
+files!/strong) to the [EMAIL PROTECTED] mailing list.
/p
- /section
- section name=Doing it your way
-
-pFor reasons of expediency, you might be tempted to do things in
-your own way. Once you know HTML who needs Anakia, right? This is the
-incorrect approach but we will explore it so that the basic steps for
-updating your site on Jakarta become clearer. /p
-
-pAssuming your project is called emmyproject/em, here are steps
-you should follow:/p
-
-ol
- liLogon to the machine hosting the Jakarta web site./li
-
- liCreate a directory named codemyproject/code under the
- code/www/jakarta.apache.org//code directory./li
+p
+You should edit the .xml files and then run build.sh. After you have
+done that, you should check in both the .xml files and the .html files.
+Once your changes have been checked in, you can do the following:
+/p
- liCopy your HTML files under the newly created directory./li
+source
+cd /www/jakarta.apache.org
+cvs update index.html
+cd site
+cvs update
+/source
- liThat's it!/li
-/ol
+p
+This will cause the files checked into the jakarta-site2/docs directory
+to be checked out and updated on the live website.
+/p
+/section
-pThe new project's web-pages should be accessible under
-codehttp://jakarta.apache.org/myproject/code. /p
+section name=Creating Web Pages For A (New) Project The Anakia Way
+subsection name=Using the jakarta-site2 module as a dependency
+p
+If you would like to use the jakarta-site2 module as a dependency for
+your project, here are the instructions for how to do that. The benefit
+of using it as a dependency is that you will be able to easily adopt the
+look and feel of the entire Jakarta website while being able to continue
+to have control over your own project's documentation navigation. It is
+the recommended, but optional way to develop documentation for projects
+hosted under the main Jakarta Project.
+/p
+/subsection
-pThe important point to remember is that emyou are responsible for
-updating your project pages/em. This statement remains true even if
-you switch to the recommended procedure described below./p
-
-pIf you decide to place your project's web pages under CVS control,
-then the pages should pertain to your project's CVS module and
-bnot/b to the codejakarta-site2/code module. For example, the
-contents of code/www/jakarta.apache.org/regexp/CVS/Repository/code
-refer to codejakarta-regexp/docs/code and in no way to the
-codejakarta-site2/code module. Ask for help if you don't see what
-we are talking about./p
-
-pThere are several problems with the do-it-your-way approach we have
-just outlined. First, the codemyproject/code pages are not linked
-to from the other Jakarta project pages. Your project is just
-dangling off Jakarta. Second, your web-pages do not
