Add warning to people making tutorial updates
hkclark [Thu, 1 Sep 2011 20:24:29 +0000 (16:24 -0400)]
And exclude the warning from builds

MANIFEST.SKIP
_UPDATERS_PLEASE_READ_THIS_.txt [new file with mode: 0644]

index 3880d66..099b84f 100644 (file)
@@ -29,3 +29,6 @@
 
 # No tarballs!
 \.gz$
+
+# Author/Updater-Only Notes
+^_UPDATERS_PLEASE_READ_THIS_.txt$
diff --git a/_UPDATERS_PLEASE_READ_THIS_.txt b/_UPDATERS_PLEASE_READ_THIS_.txt
new file mode 100644 (file)
index 0000000..2d46d75
--- /dev/null
@@ -0,0 +1,24 @@
+=============================================================
+=============================================================
+ IMPORTANT NOTES FOR PEOPLE MAKING UPDATES TO THE *TUTORIAL*
+=============================================================
+=============================================================
+
+If you are updating **TUTORIAL** and doing more than a **TYPO FIX**,
+please be careful to not update the configuration code without also:
+
+    * Testing the code not only for that chapter, but all
+        chapters that follow (the chapters build on each other).
+    * Make sure the changes you make in a subroutine are reflected
+        in later examples of the same subroutine in that chapter
+        and all the chapters that follow.
+    * Updating the code in the /root/Final directory of the Tutorial
+        Virtual Machine image.
+
+Feel free to ping Kennedy Clark at hkclark@gmail.com or hkclark@cpan.org
+for help.
+
+If you are only updating non-code typo fixes or updating Catalyst::Manual
+outside of the Tutorial, then the information above does not apply. :-)
+
+Thanks