diff options
Diffstat (limited to 'qpid/doc/website/README.txt')
| -rw-r--r-- | qpid/doc/website/README.txt | 28 |
1 files changed, 22 insertions, 6 deletions
diff --git a/qpid/doc/website/README.txt b/qpid/doc/website/README.txt index dcb3b423e5..6a0c2876ab 100644 --- a/qpid/doc/website/README.txt +++ b/qpid/doc/website/README.txt @@ -1,10 +1,26 @@ -To edit the website, check out the /site repo area: +This is the source directory for creating web pages for the Qpid web +site. - svn co https://svn.apache.org/repos/asf/qpid/site +The template used for all pages (template.html), stylesheet +(style.css), and images are in the ./template directory. -The HTML files for the site reside in the docs directory, where a README -can be found to describe the process of adding new content. +The tools directory contains a very simple Python script (wrap) that +combines a template and content to create static html pages. Content +should be written in XHTML, with one <div/> element at the root - see +./content/home.html for an example. -It is no longer necessary to generate the main website pages, the live files -are now edited directly, and are deployed to the web server after check in. +Use wrap like this: +$ tools/wrap template/template.html content/<filename> build/<filename> + +Content for the main pages should be check into the content +directory. Content for documentation is created in the ../book +directory. + +To publish generated content, check out the website repo: + +$ svn co https://svn.apache.org/repos/asf/qpid/site/docs + +Copy generated content (NOT the source!) into the website repo, add it +using $ svn add, and commit it. When it is committed, it appears on +the website. |