[Checkins] SVN: bluebream/website/docs/v1.0/ move technical decisions to developer docs

Baiju M baiju.m.mail at gmail.com
Fri Jan 15 11:06:32 EST 2010


Log message for revision 108153:
  move technical decisions to developer docs
  

Changed:
  A   bluebream/website/docs/v1.0/dev/decisions.rst
  U   bluebream/website/docs/v1.0/dev/index.rst
  D   bluebream/website/docs/v1.0/notes.txt

-=-
Added: bluebream/website/docs/v1.0/dev/decisions.rst
===================================================================
--- bluebream/website/docs/v1.0/dev/decisions.rst	                        (rev 0)
+++ bluebream/website/docs/v1.0/dev/decisions.rst	2010-01-15 16:06:31 UTC (rev 108153)
@@ -0,0 +1,42 @@
+Technical Decisions
+-------------------
+
+- BlueBream is a "web framework".
+
+- Shortening BlueBream as Bream or BB is acceptable.
+
+- The only public API exposed by "bluebream - the package"
+  is an entry point::
+
+    "paste.paster_create_template":
+        ["bluebream = bluebream.template:BlueBream"]
+
+  The implementation of "bluebream" template is defined in
+  "bluebream.template.BlueBream".  The template implementation
+  location could be changed if required later.  This leaves us an
+  option to change "bluebream" as a namespace package if desired.
+
+- All the framework code will be using "zope" or "zope.app" namespace
+  packages.  Although "bream" could be considered as a namespace
+  package in future.
+
+- "bluebream" the project consists of
+
+   - documentation
+
+   - compatibility test suite
+
+   - project template
+
+   May be documentation and compatibility test suite could be
+   separated out to separate locations/packages later.
+
+- BlueBream 1.0 should provide an up-gradation path from Zope 3.4 KGS
+
+- Any "shell command" need to be repeated should not be automated by
+  the project template.
+
+- Running ``bootstrap.py`` and ``buildout`` inside project should not
+  be added to project template creation for the previous reason.
+  Another supporting reason is the easiness of adding sources to
+  version controlling system.

Modified: bluebream/website/docs/v1.0/dev/index.rst
===================================================================
--- bluebream/website/docs/v1.0/dev/index.rst	2010-01-15 15:59:47 UTC (rev 108152)
+++ bluebream/website/docs/v1.0/dev/index.rst	2010-01-15 16:06:31 UTC (rev 108153)
@@ -4,3 +4,9 @@
 These documents are written for core development team.  Always visit
 the latest documentation site for recent version of these documents
 which is actually used by the developers.
+
+.. toctree::
+   :numbered:
+   :maxdepth: 2
+
+   decisions

Deleted: bluebream/website/docs/v1.0/notes.txt
===================================================================
--- bluebream/website/docs/v1.0/notes.txt	2010-01-15 15:59:47 UTC (rev 108152)
+++ bluebream/website/docs/v1.0/notes.txt	2010-01-15 16:06:31 UTC (rev 108153)
@@ -1,64 +0,0 @@
-Technical Decisions
--------------------
-
-- BlueBream is a "web framework".
-
-- Shortening BlueBream as Bream or BB is acceptable.
-
-- The only public API exposed by "bluebream - the package"
-  is an entry point::
-
-    "paste.paster_create_template":
-        ["bluebream = bluebream.template:BlueBream"]
-
-  The implementation of "bluebream" template is defined in
-  "bluebream.template.BlueBream".  The template implementation
-  location could be changed if required later.  This leaves us an
-  option to change "bluebream" as a namespace package if desired.
-
-- All the framework code will be using "zope" or "zope.app" namespace
-  packages.  Although "bream" could be considered as a namespace
-  package in future.
-
-- "bluebream" the project consists of
-
-   - documentation
-
-   - compatibility test suite
-
-   - project template
-
-   May be documentation and compatibility test suite could be
-   separated out to separate locations/packages later.
-
-- BlueBream 1.0 should provide an up-gradation path from Zope 3.4 KGS
-
-- Any "shell command" need to be repeated should not be automated by
-  the project template.
-
-- Running ``bootstrap.py`` and ``buildout`` inside project should not
-  be added to project template creation for the previous reason.
-  Another supporting reason is the easiness of adding sources to
-  version controlling system.
-
-Notes for developers
---------------------
-
-To upload documentation::
-
-  ./bin/sphinxbuilder
-  ./bin/buildout setup . upload_sphinx
-
-Road map
---------
-
-- Make the documentation better
-
-- Study each package in detail and help to improve its documentation
-
-- Understand how each package works together
-
-- Create a tutorial which explain creating a simple application with
-  all basic requirements
-
-- Write in detail about ZODB and how persistence works



More information about the checkins mailing list