diff options
| -rw-r--r-- | doc/website/README.txt | 27 |
1 files changed, 21 insertions, 6 deletions
diff --git a/doc/website/README.txt b/doc/website/README.txt index 1c3c700300..9eb291bccf 100644 --- a/doc/website/README.txt +++ b/doc/website/README.txt @@ -1,11 +1,26 @@ -This is the source directory for creating web pages for the Qpid web site. +This is the source directory for creating web pages for the Qpid web +site. -The template used for all pages (template.html), stylesheet (style.css), and images are in the ./template directory. +The template used for all pages (template.html), stylesheet +(style.css), and images are in the ./template directory. -The tools directory contains a very simple Python script (wrap) that combines a template and content to create an output file. Content should be written in XHTML, with one <div/> element at the root - see ./content/home.html for an example. Use wrap like this: +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. -$ tools/wrap templates/template.html content/home.html build/index.html +Use wrap like this: -The example directory shows sample output. It includes the CSS stylesheet and images needed to view the output in a web browser. +$ tools/wrap templates/template.html content build -Images associated with the template are in template/images. Images associated with content are in content/images. +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. |