Add README for 2015 site.
authorDavid Thompson <davet@gnu.org>
Fri, 22 Aug 2014 14:57:58 +0000 (10:57 -0400)
committerDavid Thompson <davet@gnu.org>
Fri, 22 Aug 2014 14:57:58 +0000 (10:57 -0400)
2015/README.md

index fcb5433ab3d2ea5397a44e4921ed58616aee0e41..28c624bcdfcfb8cc7375174bf4c430e21d0352c0 100644 (file)
@@ -1,20 +1,99 @@
 LibrePlanet 2015
 ================
 
+This is the static HTML site for LibrePlanet 2015.  Read on for
+instructions on how to setup your development environment.
+
 Setting Up Apache
 -----------------
 
-* Enable server-side include module
-  ```
-  a2enmod include
-  ```
+Apache is required in order to replicate the appearance of the website
+on the live and staging servers.
+
+### Enable server-side include module
+
+```
+a2enmod include
+```
+
+### Create virtual host
+
+Create a new file in `/etc/apache2/sites-available` with the following contents:
+
+```
+<VirtualHost *:80>
+    ServerName lp2015.libreplanet.org
+       DocumentRoot /path/to/libreplanet-static
+
+       <Directory />
+               Options FollowSymLinks
+               AllowOverride All
+        </Directory>
+       <Directory /path/to/libreplanet-static>
+               Options Indexes FollowSymLinks MultiViews
+        Options +Includes
+        XBitHack on
+               AllowOverride All
+               Order allow,deny
+               allow from all
+       </Directory>
+
+       ErrorLog ${APACHE_LOG_DIR}/error.log
+       LogLevel warn
+       CustomLog ${APACHE_LOG_DIR}/access.log combined
+</VirtualHost>
+```
+
+Replace `/path/to/libreplanet-static` with the full path to your local
+git repository.
+
+### Enable virtual host
+
+```
+a2ensite your-virtual-host
+```
+
+Replace `your-virtual-host` with the name of virtual host file you made.
 
-* Create virtual host
-  *WRITEME*
+### Restart Apache
 
-Using Server-side Includes
---------------------------
+```
+service apache2 restart
+```
+
+### Edit your hosts file
+
+Edit your system's `/etc/hosts` file and add the following to the bottom:
+
+```
+127.0.0.1 lp2015.libreplanet.org
+```
+
+### Test
+
+Visit <http://lp2015.libreplanet.org/2015> in your web browser.  If
+everything is configured properly, you will see the LibrePlanet 2015
+site, complete with header, sidebar, and footer.
+
+Enabling Server Side Includes on New Pages
+------------------------------------------
 
 Files that contain include directives must be marked as executable
 otherwise Apache will not parse them.  The directive `XBitHack on`
 enables this behavior.
+
+To mark a file as executable, run:
+
+```
+chmod +x foo.html
+```
+
+Replace `foo.html` with the desired file name.
+
+Deploying to Staging/Live Servers
+---------------------------------
+
+A system of git hooks automates deployment to the staging and live
+servers.  When you push to the `master` branch, the site is deployed
+to the staging server.  When you push to the `stable` branch, the site
+is deployed to <http://libreplanet.org>.