From: Zak Rogoff Date: Wed, 30 Nov 2016 20:33:19 +0000 (-0500) Subject: Improving documentation. X-Git-Url: https://vcs.fsf.org/?a=commitdiff_plain;h=179bf9bc17ee7a4bd1f3cc8b9a9be832585347d8;p=libreplanet-static.git Improving documentation. --- diff --git a/2017/README.md b/2017/README.md index 8d53a705..f3701d95 100644 --- a/2017/README.md +++ b/2017/README.md @@ -1,5 +1,6 @@ -LibrePlanet 2017 -================ +README version for LibrePlanet 2017 + +Heads up: to edit the Web site, you'll need a basic-to-intermediate understanding of HTML and git. ##### SECTION 1: DEVELOPMENT WORKFLOW ##### @@ -8,20 +9,23 @@ The actual LIVE site, visible at libreplanet.org/YEAR, is served from the "stabl Full workflow to make, test and deploy an edit ----------------- -* Check out the master branch and make sure it is up to date with stable. +* Check out the master branch and make sure it is up to date with origin/master. * git checkout master + * git pull * If 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.) * 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, then push master. +* If you are working on your own branch created for your edit, merge, your branch into master. * git checkout master * git merge BRANCHNAME +* Push master * git push * Review the edited version of the site at http://wiki-dev0.libreplanet.org/YEAR. You can share this with others. -* When you are satisfied, merge master into stable and then push stable. Your edits are now live. +* When you are satisfied, merge master into stable and then push stable. * git checkout stable * git merge master * git push +* Your edits are now live and visible at libreplanet.org/YEAR ##### SECTION 2: EDITING INSTRUCTIONS #####