Improving documentation.
authorZak Rogoff <zak@fsf.org>
Wed, 30 Nov 2016 20:33:19 +0000 (15:33 -0500)
committerZak Rogoff <zak@fsf.org>
Wed, 30 Nov 2016 20:33:19 +0000 (15:33 -0500)
2017/README.md

index 8d53a705c8f8dd8ca1b047f79b19069df89682e0..f3701d95fb06c59259152a68e2e971bebfd65bb5 100644 (file)
@@ -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 #####