[Checkins] SVN: grok/trunk/doc/ remove "about grok" documentation
that is now published on the Grok web site.
Kevin Teague
kevin at bud.ca
Tue Jun 24 19:46:09 EDT 2008
Log message for revision 87733:
remove "about grok" documentation that is now published on the Grok web site.
Changed:
D grok/trunk/doc/about.rst
U grok/trunk/doc/contents.rst
U grok/trunk/doc/docindex.template
U grok/trunk/doc/index.rst
U grok/trunk/doc/reference/conf.py
-=-
Deleted: grok/trunk/doc/about.rst
===================================================================
--- grok/trunk/doc/about.rst 2008-06-24 23:16:43 UTC (rev 87732)
+++ grok/trunk/doc/about.rst 2008-06-24 23:46:08 UTC (rev 87733)
@@ -1,137 +0,0 @@
-======================================
-Grok: now even cavemen can use Zope 3
-======================================
-
-Grok is a web application framework for Python developers. It is aimed
-at both beginners and very experienced web developers. Grok has an
-emphasis on agile development. Grok is easy *and* powerful.
-
-Grok: Experience, Expertise, Extensibility
-------------------------------------------
-
-You will likely have heard about many different web frameworks for
-Python as well as other languages. Why you should you consider Grok?
-
-* Grok offers a *lot* of building blocks for your web application.
-
-* Grok is informed by a *lot* of hard-earned wisdom.
-
-Grok accomplishes this by being based on Zope 3, an advanced
-object-oriented web framework. While Grok is based on Zope 3, and
-benefits a lot from it, you do not need to know Zope at all in order
-to get productive with Grok.
-
-Grok is agile
-.............
-
-Grok doesn't require you to edit cryptic configuration files. Instead
-you just program in Python and create HTML templates. Beyond this,
-Grok also offers a wide range of built-in features at your fingertips,
-from automated form generation to an object database. This way, Grok
-gives you both power and quick satisfaction during development. Grok
-is *fun*.
-
-Grok has an extensive tutorial_ that helps you to get started. And
-thanks to grokproject_, you'll be able to create your first web app
-with Grok in no time.
-
-.. _tutorial: tutorial.html
-
-.. _grokproject: http://cheeseshop.python.org/pypi/grokproject
-
-Grok offers a very wide range of features
-.........................................
-
-Through Zope 3, Grok offers a very wide range of building blocks for
-your web application. What's more, Zope 3 components are typically
-rock-solid due to extensive unit-testing and well-specified API
-documentation.
-
-Grok is grounded in a deep experience with web development
-..........................................................
-
-Grok, through Zope 3, is informed by hard-earned wisdom. Zope 3 is a
-powerful and flexible web application framework for Python that has
-been under continuous development since 2001. Zope 3's design in turn
-is based on experience with the Zope 2 platform, which has been under
-continuous development (starting with Bobo, Principia and then Zope 1)
-since 1997. The Zope community is supported by an independent
-foundation, the Zope Foundation.
-
-The Zope community has been around for a while. We've built a lot and
-learned a lot. We are in this for the long run.
-
-Grok for the future
-...................
-
-Successful web applications aren't built for a day - such an
-application will need to be maintained, extended, evolved, over a
-period of many years. Zope developers really know this. Grok, through
-Zope 3, offers an architecture that enables your application to grow
-over time.
-
-
-Grok: Zope 3 for cavemen
-------------------------
-
-Grok stands on a giant's shoulder. That giant is Zope 3.
-
-Zope 3 is an advanced object oriented web framework. Zope 3 features a
-large amount of API documentation and aims for reliability. It has a
-very large automatic test coverage (many thousands of tests). It has a
-large set of core features, and sports an enormous range of plug-in
-components.
-
-The Grok developers think Zope 3 is great. Zope 3, unfortunately, also
-has some problems: its power raises the entry barrier for developers
-to get up to speed with it. Even after you've learned it, Zope 3's
-emphasis on explicit configuration and specification of interfaces can
-slow down development.
-
-Grok aims to remedy these problems. Grok aims to make Zope 3 easier to
-learn, and more agile to work with, while retaining the power of Zope
-3.
-
-Grok appeals to the caveman or woman in all of us. Cavemen, like us
-programmers, want powerful and flexible tools. Cavemen are great at
-tools after all; they invented the whole concept of them. But cavemen,
-and we, also want our tools to be simple and effective.
-
-Cavemen want tools like clubs: a club is powerful, flexible (you can
-bash in anything, mash potatoes too) and also simple and
-effective. Zope 3 is already powerful and flexible. Grok aims to make
-it simpler and more effective, for beginners and experienced
-developers alike. Grok: now even cavemen can use Zope 3.
-
-Grok from the Zope 3 perspective
---------------------------------
-
-Zope 3 allows you to combine different components in an explicit,
-flexible way. You can hook up a view to a model, an event handler to
-an event, and a new API to an existing object. The process of doing
-this is called *configuration*. In a technical sense, Grok can be
-understood as an alternate configuration mechanism for Zope 3.
-
-Zope 3 without Grok uses ZCML for hooking up objects together. ZCML is
-an XML-based configuration language. ZCML statements are stored in
-their own file, next to the code. While using ZCML has the benefit of
-being explicit and flexible, it can also make code harder to read as
-there are more files to consult in order to understand what is going
-on.
-
-Grok does away with ZCML. Instead it analyzes your Python code for the
-use of certain special base classes and directives, and then "groks"
-it. This grokking process results in the same configuration as it
-would have if you used the equivalent ZCML. We believe that having all
-configuration along with your Python code makes the code easier to
-follow and more fun to develop.
-
-Grok has been designed so that if you organize your code in a certain
-way, you can even leave out most of the explicit directives in your
-Python code. This makes code written for Grok look clean and
-uniform. You still have all the power of explicit configuration
-available should you need it, however.
-
-During the development of Grok we have taken a careful look at common
-patterns in Zope 3 code and configuration. Grok aims to make these
-patterns easier to use and more succinct.
Modified: grok/trunk/doc/contents.rst
===================================================================
--- grok/trunk/doc/contents.rst 2008-06-24 23:16:43 UTC (rev 87732)
+++ grok/trunk/doc/contents.rst 2008-06-24 23:46:08 UTC (rev 87733)
@@ -6,7 +6,6 @@
:maxdepth: 2
changes.rst
- about.rst
tutorial.rst
grok_overview.rst
reference/index.rst
Modified: grok/trunk/doc/docindex.template
===================================================================
--- grok/trunk/doc/docindex.template 2008-06-24 23:16:43 UTC (rev 87732)
+++ grok/trunk/doc/docindex.template 2008-06-24 23:46:08 UTC (rev 87733)
@@ -1,9 +1,9 @@
- <p><strong>Parts of the documentation:</strong></p>
+ <p><strong>Sections</strong></p>
<table class="contentstable" align="center"><tr>
<td width="50%">
<p class="biglink"><a class="biglink" href="{{ pathto("changes") }}"
- >What's new in Grok {{ version }}?</a><br>
- <span class="linkdescr">changes during the releases</span></p>
+ >What's new in Grok?</a><br>
+ <span class="linkdescr">Changes between each Grok release</span></p>
<p class="biglink"><a class="biglink" href="{{ pathto("tutorial") }}"
>Tutorial</a><br>
@@ -15,10 +15,6 @@
</td><td width="50%">
- <p class="biglink"><a class="biglink" href="{{ pathto("about") }}"
- >About Grok</a><br>
- <span class="linkdescr">now even Cavemen can use Zope 3</span></p>
-
<p class="biglink"><a class="biglink" href="{{ pathto("reference/index") }}">The Grok Reference</a><br>
<span class="linkdescr">describes syntax and package elements</span></p>
@@ -28,7 +24,7 @@
</td></tr>
</table>
- <p><strong>Indices and tables:</strong></p>
+ <p><strong>Indices and tables</strong></p>
<table class="contentstable" align="center"><tr>
<td width="50%">
<p class="biglink"><a class="biglink" href="{{ pathto("contents") }}">Complete Table of Contents</a><br>
@@ -43,7 +39,7 @@
</td></tr>
</table>
- <p><strong>Meta information:</strong></p>
+ <p><strong>Further information</strong></p>
<table class="contentstable" align="center"><tr>
<td width="50%">
Modified: grok/trunk/doc/index.rst
===================================================================
--- grok/trunk/doc/index.rst 2008-06-24 23:16:43 UTC (rev 87732)
+++ grok/trunk/doc/index.rst 2008-06-24 23:46:08 UTC (rev 87733)
@@ -1,182 +0,0 @@
-=============
-What is Grok?
-=============
-
-.. image:: resources/evencaveman.jpg
- :alt: Now even cavemen can use Zope3
- :class: right
-
-Grok is a web application framework for Python developers. It is aimed at both
-beginners and very experienced web developers. Grok has an emphasis on agile
-development. Grok is easy and powerful.
-
-You will likely have heard about many different web frameworks for Python as
-well as other languages. Why should you consider Grok?
-
-* Grok offers a *lot* of building blocks for your web application.
-* Grok is informed by a *lot* of hard-earned wisdom.
-
-Grok accomplishes this by being based on `Zope 3`_, an advanced
-object-oriented web framework. While Grok is based on Zope 3, and
-benefits a lot from it, you do not need to know Zope at all in order
-to get productive with Grok.
-
-`Read More <./about.html>`_
-
-.. _Zope 3: http://wiki.zope.org/zope3
-
-Grok News
----------
-2008-01-20:
- Grok 0.11.1 has been released! See the `announcement`__ for more details!
-
- .. __: http://permalink.gmane.org/gmane.comp.web.zope.grok.devel/3565
-
-2007-11-08:
- Grok 0.11 has been released! See the release `announcement`__
- for more details! For projects that want to upgrade, please read the
- `upgrade notes <upgrade.html>`_
-
- .. __: http://permalink.gmane.org/gmane.comp.web.zope.devel/14171
-
-2007-10-24:
- Grok 0.10.2 has been released! See the `announcement`__ for more details!
-
- .. __: http://article.gmane.org/gmane.comp.web.zope.grok.devel/2786
-
-2007-10-10:
- Grok 0.10.1 has been released! See the original `announcement`__ for more
- details!
-
- .. __: http://article.gmane.org/gmane.comp.web.zope.announce/1393
-
-2007-10-05:
- Read about what was achieved during the `Grok Neanderthal Sprint`__ on the
- `Sprint Accomplishments`__ page!
-
- .. __: http://wiki.zope.org/grok/NeanderthalerSprint
- .. __: http://wiki.zope.org/grok/SprintAccomplishments
-
-2007-09-24:
- The first week of October (1-5 October) we are having the `Grok Neanderthal
- Sprint`__ in Cologne, Germany. This sprint is generously sponsored by
- `GfU Cyrus`__.
-
- .. __: http://wiki.zope.org/grok/NeanderthalerSprint
- .. __: http://www.gfu.net
-
-Who is Grok?
-------------
-
-.. image:: ./resources/grok-standing.jpg
- :alt: Grok!
- :class: right
-
-Grok is a friendly caveman from the Stone Age. He has a big club that he hunts
-mammoths with. He will also use this club to smash anything he doesn't like.
-
-"ME GROK SMASH ZCML!"
-
-The word grok comes from the novel `Stranger in a Strange Land`_ by Robert A.
-Heinlein, and is defined in his book as:
-
- Grok means to understand so thoroughly that the observer becomes part of the
- observed - to merge, blend, intermarry, lose identity in group experience.
-
-.. _Stranger in a Strange Land: http://en.wikipedia.org/wiki/Stranger_in_a_Strange_Land
-
-Watch Grok in Action
---------------------
-
-* `Simple ToDo`_ application is a tutorial-style introduction to Grok by Philipp von Weitershausen.
-* `Introduction to Grok`_ is a talk given by Philipp von Weitershausen to a group of Zope developers.
-
-.. _Simple ToDo: http://www.archive.org/details/grok_todo_part1
-.. _Introduction to Grok: http://comlounge.tv/blog/zope/cltv23-snow-sprint-2007-grok-presentation
-
-What does Grok code look like?
-------------------------------
-
-::
-
- import grok
-
- class HelloWorld(grok.Application, grok.Model):
- pass
-
- class Index(grok.View):
- pass
-
- index = grok.PageTemplate("""
- <html><body>
- <p>ME GROK HELLO WORLD!</p>
- </body></html>
- """")
-
-* `Herd of Mammoths`_: a very simple application that only goes a bit beyond "hello world".
-* `Grokstar`_: a simple blog application written with Grok.
-* `Grok Wiki`_: a simple wiki application written with Grok.
-* `Paleosoft.org`_: a collection of sample apps written in Grok/Zope3 by
- Luciano Ramalho as part of the Google Summer of Code.
-
-.. _Herd of Mammoths: http://www.z3lab.org/sections/blogs/philipp-weitershausen/2007_01_09_you-thought-zope-3-wasn
-.. _Grokstar: http://svn.zope.org/Grokstar/
-.. _Grok Wiki: http://svn.zope.org/grok/trunk/grokwiki/
-.. _Paleosoft.org: http://paleosoft.org/
-
-ME GROK HYPERLINKS!
--------------------
-
-* Get the latest version in the form of a `Grok Python Package`_ from the Python Cheese Shop.
-* Feature requests and bugs are tracked in the `Grok Issue Tracker`_ at LaunchPad.
-* `Grok-dev mailing list`_ for discussing the development of Grok.
-* There is a `Grok IRC`_ channel on `freenode.net`_
-
-.. _Grok Python Package: http://cheeseshop.python.org/pypi/grok
-.. _Grok Issue Tracker: https://launchpad.net/grok
-.. _Grok-dev mailing list: http://mail.zope.org/mailman/listinfo/grok-dev
-.. _Grok IRC: irc://irc.freenode.net/grok
-.. _freenode.net: http://freenode.net/
-
-The source code to Grok is kept in the Zope SVN repository. You can do an
-anonymous check out of the latest version of Grok with the following command:::
-
- svn co svn://svn.zope.org/repos/main/grok/trunk grok
-
-ME GROK TUTORIAL!
-------------------
-
-* `Grok tutorial`__
-
- .. __: tutorial.html
-
-ME GROK SPRINTS AND BLOGS!
---------------------------
-
-Grok development is often done in the form of sprints. A sprint is a when a
-group of developers get together in the same place and all work on a focused
-set of tasks.
-
-* People `blogged <http://wiki.zope.org/grok/SprintAccomplishments>`_ about
- the `Grok Neanderthal Sprint <http://wiki.zope.org/grok/NeanderthalerSprint/>`_.
-
-* `Jan-Wijbrand Kolman blogged`_ about the second Grok sprint, and
- `Martijn Faassen blogged`_ about it as well.
-
-* `Martijn Faassen's blog entry`_ details the first Grok sprint.
-
-.. _Martijn Faassen's blog entry: http://faassen.n--tree.net/blog/view/weblog/2006/11/09/0
-.. _Jan-Wijbrand Kolman blogged: http://jw.n--tree.net/blog/dev/python/second-grok-sprint
-.. _Martijn Faassen blogged: http://faassen.n--tree.net/blog/view/weblog/2007/01/09/0
-
-.. toctree::
-
- about.rst
- contents.rst
- grok_overview.rst
- reference/index.rst
-
- bugs.rst
- README.rst
- license.rst
- copyright.rst
Modified: grok/trunk/doc/reference/conf.py
===================================================================
--- grok/trunk/doc/reference/conf.py 2008-06-24 23:16:43 UTC (rev 87732)
+++ grok/trunk/doc/reference/conf.py 2008-06-24 23:46:08 UTC (rev 87733)
@@ -129,7 +129,7 @@
# (source start file, target name, title, author, document class [howto/manual]).
#latex_documents = []
latex_documents = [
- ('index', 'reference.tex', 'Grok Reference', 'The Grok Team', 'manual')
+ ('reference.tex', 'Grok Reference', 'The Grok Team', 'manual')
]
# Additional stuff for the LaTeX preamble.
More information about the Checkins
mailing list