/-----------------------\ | Apache Thrift Website | \-----------------------/ LICENSE Copyright 2008- Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. ABOUT The Apache web infrastructure requires serving static HTML files. Developing a templatized website in static HTML is relatively inefficient and verbose. This lightweight PHP-implementation of a basic branding/documentation site is optimized for quick-and-painless development in a trivial sandbox environment, whilst allowing painless compilation down to static HTML. 0. Requirements This site require a vanilla build of PHP, version 5 or newer. 1. Developing the site Checkout this code, and mount this local folder on a web sandbox running PHP under the folder /thrift/ (all links are relative to /thrift/ as an absolute root). All of the pages are implemented in the files /index.php. This lets you develop the site without any build process between iterations. Simply modify the PHP source directly and click refresh. 2. Generating static HTML When you're done, the __publish.php script is used to generate the PHP scripts down to static HTML. By default, it will generate into a publish- folder under this directory, useful for sanity checking. To publish into the production output folder, run as follows: ./__publish.php -o ../publish 3. File layout To ease serving in both development and production environments, note that the file layout relies upon default directory indexing via index.php or the generated index.html files. If you are adding a new page, create a folder for it, and add it to the list in the __publish.php script. Purely static content (CSS, image files, pdfs) should always be placed under the static folder.