Added:
wiki/ManualOutline.wiki
Log:
Started sketching out an outline for the OSP manual
Added: wiki/ManualOutline.wiki
==============================================================================
--- (empty file)
+++ wiki/ManualOutline.wiki Tue Apr 21 15:56:05 2009
@@ -0,0 +1,40 @@
+#summary An outline for the Open Sever Platform manual
+#labels Phase-Design,Phase-Deploy
+
+= Introduction =
+Basic introduction to the OSP technology
+== Features ==
+Why use OSP, what is does, and what is left for the users/developers
+== Example Usage ==
+Company XYZ and their issues with high load on servers, using OSP to help
+
+----
+
+= Requirements & Installation =
+== Code requirements ==
+Dependencies, working environment, etc...
+== Cluster layout ==
+Using company XYZ's layout as an example, but going deeper into the needs
+== Installing OSP ==
+Setting everything up through running an example servlet
+
+----
+
+= Advanced Usage =
+== Replication ==
+How-to, caveats, challenges
+== Diskless ==
+How to, other concerns
+
+----
+
+= Developing servlets =
+== Core concepts ==
+SDF file format, .erl development
+== Code by numbers example: IRC servlet ==
+Basic design, fleshing out, and final product
+
+----
+
+= Conclusion =
+What OSP is useful for, where it's going, and how you can help!
\ No newline at end of file