Return-Path: X-Original-To: apmail-httpd-cvs-archive@www.apache.org Delivered-To: apmail-httpd-cvs-archive@www.apache.org Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by minotaur.apache.org (Postfix) with SMTP id 44769C8CC for ; Fri, 11 May 2012 17:06:05 +0000 (UTC) Received: (qmail 42598 invoked by uid 500); 11 May 2012 17:06:05 -0000 Delivered-To: apmail-httpd-cvs-archive@httpd.apache.org Received: (qmail 42482 invoked by uid 500); 11 May 2012 17:06:05 -0000 Mailing-List: contact cvs-help@httpd.apache.org; run by ezmlm Precedence: bulk Reply-To: dev@httpd.apache.org list-help: list-unsubscribe: List-Post: List-Id: Delivered-To: mailing list cvs@httpd.apache.org Received: (qmail 42474 invoked by uid 99); 11 May 2012 17:06:04 -0000 Received: from athena.apache.org (HELO athena.apache.org) (140.211.11.136) by apache.org (qpsmtpd/0.29) with ESMTP; Fri, 11 May 2012 17:06:04 +0000 X-ASF-Spam-Status: No, hits=-2000.0 required=5.0 tests=ALL_TRUSTED X-Spam-Check-By: apache.org Received: from [140.211.11.4] (HELO eris.apache.org) (140.211.11.4) by apache.org (qpsmtpd/0.29) with ESMTP; Fri, 11 May 2012 17:06:03 +0000 Received: from eris.apache.org (localhost [127.0.0.1]) by eris.apache.org (Postfix) with ESMTP id 4428C2388860; Fri, 11 May 2012 17:05:43 +0000 (UTC) Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Subject: svn commit: r1337284 - /httpd/site/trunk/README Date: Fri, 11 May 2012 17:05:43 -0000 To: cvs@httpd.apache.org From: joes@apache.org X-Mailer: svnmailer-1.0.8-patched Message-Id: <20120511170543.4428C2388860@eris.apache.org> X-Virus-Checked: Checked by ClamAV on apache.org Author: joes Date: Fri May 11 17:05:42 2012 New Revision: 1337284 URL: http://svn.apache.org/viewvc?rev=1337284&view=rev Log: update to the CMS instructions Modified: httpd/site/trunk/README Modified: httpd/site/trunk/README URL: http://svn.apache.org/viewvc/httpd/site/trunk/README?rev=1337284&r1=1337283&r2=1337284&view=diff ============================================================================== --- httpd/site/trunk/README (original) +++ httpd/site/trunk/README Fri May 11 17:05:42 2012 @@ -1,53 +1,58 @@ Building the website: --------------------- -In order to build the documentation, you will need to have a Java 1.2 JVM -or higher installed. You will also need to set the JAVA_HOME environment -variable. +No longer necessary- the CMS will build the site upon committing a change. +If you prefer to check the build *before* committing, see -If you install Ant 1.3 or higher, it will make the process easier for you: + http://www.apache.org/dev/cmsref#local-build - - -If you have Ant installed, all you need to do is cd into this directory -and type: - - ant - -If you do not have Ant installed, all you need to do is cd into this -directory and type: - - ./build.sh Modifying the website: ---------------------- See also http://httpd.apache.org/docs-project/docsformat.html -To modify the website, all you need to do is edit the files in the xdocs -directory and then rebuild the website. The format of the files is fairly -straightforward. You should only add XHTML tags because the .xml files -need to be parsed by an XML parser. +To modify the website, all you need to do is edit the files in the content/ +directory and then commit your changes. The format of the files is markdown: + + http://www.apache.org/dev/cmsref#markdown Changing the look and feel of the entire website is easy. Just modify the -site.vsl file located in the xdocs/stylesheets directory and rebuild. +files located in the templates/ directory and commit. If you would like to add links to the left side navigation, simply edit -the project.xml file in the xdocs/stylesheets directory and rebuild. +the templates/navigation.mdtext file and commit. + +Place your images in the content/images directory. When you commit, the +modified images will be copied over and committed back to the staging tree +by the CMS. + +Non-committers may use the passwordless "anonymous" account on the CMS +in conjunction with the CMS's bookmarklet to post diffs to the docs@httpd +mailing list for a committer to apply. Simply submit your edits (sans +Quick-Commit) to the CMS, click on the provided [Diff] link, which will +provide a [Mail Diff] link. Clicking on that, filling out the form and +submitting it will mail your changes to the provided mailing list. -Place your images in the xdocs/images directory. When you rebuild, the -modified images will be copied over to the docs/images directory. Publishing on httpd.apache.org (for committers only): ----------------------------------------------------- -After you have reviewed the changes (in xml and html files) using: +After you have reviewed the changes on the staging site at + + http://httpd.staging.apache.org/ + +You may publish the changes to the live site, either by visiting + + https://cms.apache.org/httpd/publish + +or by executing the perl publication script -svn diff . + % GET http://s.apache.org/cms-cli | perl -You may commit the changes to the repository: +or with a proper installation located on people.apache.org: -svn commit . + $ ssh -t $user@people.apache.org publish.pl httpd $user The changes should be reflected immediately on httpd.apache.org via the automatic svnpubsub. If the changes don't take effect, this may