Heads up: to edit the Web site, you'll need a basic-to-intermediate understanding of HTML and git.
-##### SECTION 1: DEVELOPMENT WORKFLOW #####
+# SECTION 1: DEVELOPMENT WORKFLOW
The actual LIVE site, visible at libreplanet.org/YEAR, is served from the "stable" branch of the git repository using a git hook. There is also a development branch called "master" which we use to preview edits on the Web. The master branch is served to the Web at http://wiki-dev0.libreplanet.org/YEAR and publicly visible, but not linked to.
-Full workflow to make, test and deploy an edit
+Full workflow to make, test and deploy an edit.
-----------------
* Check out the master branch and make sure it is up to date with origin/master by doing:
* git checkout master
* git pull
* Is this a large edit or a small edit? If it is small, edit, work in master. If this is a large edit that will take longer than a day, make a new branch based on the master branch and work there.
-* Make your edits. (See instructions for editing content below.)
+* Make your edits. (See site structure and instructions for editing content below.)
* Optionally, test them on your computer with a local development environment. (See instructions below for setting up your development environment).
* If you are working on your own branch created for your edit, merge, your branch into master by doing:
* git checkout master
* git push
* Your edits are now live and visible at libreplanet.org/YEAR
-##### SECTION 2: EDITING INSTRUCTIONS #####
+# SECTION 2: SITE STRUCTURE
-To change content on existing pages, simply use your favorite text editor.
+The site is made up of HTML files, each representing part of a page (sidebar, content, footer, etc.). When a browser visits the site, the server finds the core HTML file for the page (for example, the core file for https://www.libreplanet.org/YEAR/getting-around is /YEAR/getting-around/index.html in the repo), then reads special comments in that file to which instruct it to pull various other HTML files in to produce a complete page, using an Apache feature called SSI. To edit part of a page, you will need to find out which HTML file contains the element in question. Do this by navigating to core HTML file and exploring the comments that start with "#include".
+
+The bios page and the sessions page are maintained through a special workflow to make it easy to have only one canonical copy edited by humans. That canonical copy is saved in brains (the FSF's internal wiki) in a special format. To update the sites' sessions page or bios page, you will need the lps_gen program installed on your computer (<http://pythonhosted.org/lpschedule-generator>), as well as a local checkout of the SVN repository that contains brains.
This site is built with [Bootstrap 3.3.5](https://github.com/twbs/bootstrap/releases/download/v3.3.5/bootstrap-3.3.5-dist.zip) and [jQuery 1.11.1](http://code.jquery.com/jquery-1.11.3.js) but you do not need to understand either of these technologies to make minor content edits to the site.
-Creating a New Page
--------------------
+# SECTION 3: EDITING INSTRUCTIONS
+
+To change content on existing pages, use your favorite text editor.
+
+Here are specific instructions for more complex editing tasks:
+
+## Editing the schedule
+
+See instructions at <http://pythonhosted.org/lpschedule-generator>. For 2017, the jinja2 templates are stored in the the Web site's git repo at assets/templates.
+
+## Editing the bios page
+
+See instructions at <http://pythonhosted.org/lpschedule-generator>. For 2017, the jinja2 templates are stored in the the Web site's git repo at assets/templates.
+
+Please crop all photos of speakers too 100x100 px (200x200 px for keynotes) and then upload them to <http://static.fsf.org/nosvn/libreplanet/speaker-pics/>. Then include their URL in the bios page to embed them.
+
+## Creating a New Page
*Boilerplate*
Replace `foo.html` with the desired file name.
-Modifying top-right corner
---------------------------
+## Modifying top-right corner
In the `/2017/includes/banner.html` find the `...#top-right-desktop
start...` section.
<!-- #top-right-desktop end -->
-##### SECTION 3: SETTING UP A LOCAL DEVELOPMENT ENVIRONMENT #####
+# SECTION 4: SETTING UP A LOCAL DEVELOPMENT ENVIRONMENT
Apache is required in order to replicate the appearance of the website
on the live and staging servers on your machine. If you don't want to
projects / libreplanet-static.git / blobdiff