Readme Files (#2)

Some tweaks to readme files and code comments

Author: pbailie

README.md

@@ -5,11 +5,10 @@ Submitty used by Rensselaer Polytechnic Institute, Dept. of Computer Science.
 *Some modification of these scripts may be necessary to be compatible with your
 school's information systems.*
 
-WARNING:  Many of these scripts are intended to process private student
-information that is protected by [FERPA (20 U.S.C. § 1232g)]
-(https://www2.ed.gov/policy/gen/guid/fpco/ferpa/index.html).
+WARNING:  Some of these scripts are intended to process private student
+information that is protected by [FERPA (20 U.S.C. § 1232g)](https://www2.ed.gov/policy/gen/guid/fpco/ferpa/index.html).
 Please contact your school's IT dept. for advice on your school's data security
-practices.
+policies and practices.
 
 Licensed under the [BSD 3-Clause License](LICENSE).
 

nightly_db_backup/readme.md

@@ -59,8 +59,7 @@ this argument be ommitted.
 ---
 
 Submitty databases can be restored from a dump using the pg_restore tool.
-q.v. [https://www.postgresql.org/docs/9.5/static/app-pgrestore.html]
-(https://www.postgresql.org/docs/9.5/static/app-pgrestore.html)
+q.v. [https://www.postgresql.org/docs/9.5/static/app-pgrestore.html](https://www.postgresql.org/docs/9.5/static/app-pgrestore.html)
 
 This is script intended to be run as a cronjob by 'root' on the same server
 machine as the Submitty system.  *Running this script on another server other
@@ -86,9 +85,9 @@ folders, grouped by semester.
 ---
 
 WARNING:  Database dumps can contain student information that is protected by
-[FERPA (20 U.S.C. § 1232g)]
-(https://www2.ed.gov/policy/gen/guid/fpco/ferpa/index.html).  Please consult
-with your school's IT dept. for advice on data security practices and policies.
+[FERPA (20 U.S.C. § 1232g)](https://www2.ed.gov/policy/gen/guid/fpco/ferpa/index.html).
+Please consult with your school's IT dept. for advice on data security policies
+and practices.
 
 ---
 

student_auto_feed/config.php

@@ -5,18 +5,11 @@
  * config.php script used by submitty_student_auto_feed
  * By Peter Bailie, Systems Programmer (RPI dept of computer science)
  *
- * Requires minimum PHP version 5.4 with pgsql, iconv, and ssh2 extensions.
+ * Requires minimum PHP version 5.6 with pgsql, iconv, and ssh2 extensions.
  *
- * Configuration of submitty_student_auto_feed is structured through a series
- * of named constants.  This configuration is also used by
- * submitty_users_data_backup.php
- * submitty_users_data_rollback.php
- *
- * THIS SOFTWARE IS PROVIDED AS IS AND HAS NO GUARANTEE THAT IT IS SAFE OR
- * COMPATIBLE WITH YOUR UNIVERSITY'S INFORMATION SYSTEMS.  THIS IS ONLY A CODE
- * EXAMPLE FOR YOUR UNIVERSITY'S SYSYTEM'S PROGRAMMER TO PROVIDE AN
- * IMPLEMENTATION.  IT MAY REQUIRE SOME ADDITIONAL MODIFICATION TO SAFELY WORK
- * WITH YOUR UNIVERSITY'S AND/OR DEPARTMENT'S INFORMATION SYSTEMS.
+ * Configuration of submitty_student_auto_feed is structured through defined
+ * constants.  Expanded instructions can be found at
+ * http://submitty.org/sysadmin/student_auto_feed
  *
  * -------------------------------------------------------------------------- */
 
@@ -39,7 +32,6 @@
 date_default_timezone_set('America/New_York');
 
 
-
 /* Definitions for error logging -------------------------------------------- */
 // While not recommended, email reports of errors may be disabled by setting
 // 'ERROR_EMAIL' to null.

student_auto_feed/readme.md

@@ -1,11 +1,10 @@
 # Submitty Student Auto Feed Script
 Readme June 26, 2018
 
-These are code examples for any University to use as a basis to have student
-enrollment data added or updated.
+This is a code example for any University to use as a basis to have student
+enrollment data added or updated on an automated schedule.
 
-Instructions can be found at [http://submitty.org/sysadmin/student\_auto\_feed]
-(http://submitty.org/sysadmin/student_auto_feed)
+Instructions can be found at [http://submitty.org/sysadmin/student\_auto\_feed](http://submitty.org/sysadmin/student_auto_feed)
 
 ### config.php
 A series of define statements that is used to configure the auto feed script.
@@ -21,13 +20,13 @@ CSV file.  Extra courses can exist in the data (such as a department wide CSV),
 and any enrollments for courses not registered in Submitty are ignored.
 
 Conceptually, a University's registrar and/or data warehouse will provide a
-regular data dump, uploaded somewhere as a CSV file.  Then with the automatic
-uploads scheduled, a sysadmin should setup a cron job to regularly trigger this
-script to run sometime after the data dump is provided.
+regularly scheduled data dump, uploaded somewhere as a CSV file.  A sysadmin
+should setup a cron job to regularly trigger this script to run when the CSV
+file is available.
 
-This code does not need to be run specifically on the Submitty server, but it
-will need access to the Submitty "master" database and the enrollment CSV data
-file.
+The auto feed script does not need to be run specifically on the Submitty
+server, but it will need access to the Submitty "master" database and the
+enrollment CSV data file.
 
 ---
 
@@ -56,6 +55,13 @@ will follow the pattern of TYY, where
 
 ---
 
+WARNING:  Student enrollment CSV files may contain private student
+information that is protected by [FERPA (20 U.S.C. § 1232g)](https://www2.ed.gov/policy/gen/guid/fpco/ferpa/index.html).
+Please contact your school's IT dept. for advice on your school's data security
+policies and practices.
+
+---
+
 Requires at least PHP 5.6 with pgsql, iconv, and ssh2 extensions.
 
 NOTE: Some modification of code may be necessary to work with your school's

student_auto_feed/submitty_student_auto_feed.php

@@ -21,12 +21,6 @@
  *
  * Will run the auto feed for the Spring 2018 semester.
  *
- * THIS SOFTWARE IS PROVIDED AS IS AND HAS NO GUARANTEE THAT IT IS SAFE OR
- * COMPATIBLE WITH YOUR UNIVERSITY'S INFORMATION SYSTEMS.  THIS IS ONLY A CODE
- * EXAMPLE FOR YOUR UNIVERSITY'S SYSTEMS PROGRAMMER TO PROVIDE AN
- * IMPLEMENTATION.  IT MAY REQUIRE SOME ADDITIONAL MODIFICATION TO SAFELY WORK
- * WITH YOUR UNIVERSITY'S AND/OR DEPARTMENT'S INFORMATION SYSTEMS.
- *
  * Requires minimum PHP version 5.6 with pgsql, iconv, and ssh2 extensions.
  *
  * @author Peter Bailie, Systems Programmer (RPI dept of computer science)