Commits

Anonymous committed 5c56d92

Text.

  • Participants
  • Parent commits 81a32a8

Comments (0)

Files changed (2)

File docs/index.rst

 
 Akhet is a set of tutorial-level documentation and convenience code for
 Pyramid_. Version 2 focuses more heavily on documentation, and does not contain
-an application scaffold [#]_. Instead the
-documentation shows how to customize Pyramid's built-in scaffolds to give a
-Pylons-like environment, and it discusses the tradeoffs between various
-alternative APIs. The Akhet library (the convenience classes) are unchanged in
+an application scaffold [#]_. Instead the documentation shows how to customize
+Pyramid's built-in scaffolds to give a Pylons-like environment. The
+documentation focuses on things that either aren't in the Pyramid manual or
+deserve highlighting, and it also discusses the tradeoffs between various
+alternative APIs.  The Akhet library (the convenience classes) are unchanged in
 this release.
 
 Akhet 2.0 runs on Python 2.5 - 2.7.   The next version will probably add

File docs/intro.rst

 feature requires pasting in only a few lines of code, and by doing it yourself
 you'll get a better feel of how it's implemented and what it's doing. 
 
-.. topic:: Rant about scaffolds 
+Rant about scaffolds and PasteScript
+------------------------------------
 
-    There are four main reasons.
+The main reason the scaffold is gone is that maintaining it turned out to be a
+significant burden. Testing a scaffold requires several manual steps -- every
+time you change a bit of code. Scaffolds aren't inheritable, so you can't just
+specify the differences from an existing scaffold, you have to copy the whole
+thing... and then duplicate any later changes that get made to the original.
+The scaffold API is primitive and limited. 
 
-    1. Pyramid users' biggest request has been for "more tutorials".
-    2. Maintaining a scaffold turned out to be significantly burdensome.
-    3. The scaffold is based on PasteScript, which Pyramid is moving away from.
+The final barrier
+was Python 3. Other packages descended from Paste have been ported to 3
+(PasteDeploy, WebOb), but Paste and PasteScript haven't been. There doesn't
+seem to be much point because the scaffold API needs to be overhauled anyway,
+many of paster's subcommands are obsolete, and some people question the whole
+concept of plugin subcommands: what exactly is its benefit over bin scripts?
 
-    There are several problems with maintaining a scaffold. Testing it requires
-    several manual steps -- every time you change a bit of code. Scaffolds aren't
-    inheritable, so you can't just specify the differences from an existing
-    scaffold, you have to copy the whole thing... and duplicate any later changes
-    in the original. The scaffold API is primitive and limited. The final barrier
-    was Python 3. Other packages descended from Paste have been ported to 3
-    (PasteDeploy, WebOb), but Paste and PasteScript haven't been. There doesn't
-    seem to be much point because the scaffold API needs to be overhauled anyway,
-    many of paster's subcommands are obsolete, and some people question the whole
-    concept of plugin subcommands: what exactly is its benefit over bin scripts?
+Pyramid 1.3 drops the Paste and PasteScript
+dependencies, and adds bin scripts for the essential utilities Pyramid needs:
+'pcreate', 'pserve', 'pshell', 'proutes', 'ptweens', and 'pviews'. These were
+derived from the Paste code, and the scaffold API is unchanged.
 
-    Pyramid 1.3 (to be released by the end of 2011) drops the Paste and PasteScript
-    dependencies, and adds bin scripts for the essential utilities Pyramid needs:
-    'pcreate', 'pserve', 'pshell', 'proutes', 'ptweens', and 'pviews'. These were
-    derived from the Paste code, and the scaffold API is unchanged.
-
-    1. Some users like to mix and match between Akhet features and other features. 
-    2. The 'akhet' scaffold can't absorb every new feature that comes down the
-       block. 
-    3.  Pasting the code yourself helps you understand how it's implemented. 
-    4. It makes the Akhet maintainer happier because he can sluff the
-       responsibility of maintaining the scaffold onto somebody else who's doing it
-       already, and it will automatically be updated as Pyramid changes.
-
-    The other thing that happened this year is users kept asking for "more
-    tutorials". People want more examples of how to get started with their first
-    application, how to choose between alternative API styles and libraries, and
-    examples of larger integrated applications (with AJAX and the whole hog). This
-    Akhet manual won't help with the last one, but it's adding content for the
-    first two.
 
 
 .. _[#]: There is discussion about changing 'starter' to URL dispatch,