[Checkins] SVN: grok/trunk/doc/ tidy up the Official Grok
Documentation home page
Kevin Teague
kevin at bud.ca
Wed Jun 25 16:06:58 EDT 2008
Log message for revision 87774:
tidy up the Official Grok Documentation home page
Changed:
U grok/trunk/doc/conf.py
U grok/trunk/doc/docindex.template
-=-
Modified: grok/trunk/doc/conf.py
===================================================================
--- grok/trunk/doc/conf.py 2008-06-25 16:33:25 UTC (rev 87773)
+++ grok/trunk/doc/conf.py 2008-06-25 20:06:55 UTC (rev 87774)
@@ -48,7 +48,7 @@
master_doc = 'index'
# General substitutions.
-project = 'Grok'
+project = 'Official Grok'
copyright = '2006-2008, The Zope Foundation'
# The default replacements for |version| and |release|, also used in various
Modified: grok/trunk/doc/docindex.template
===================================================================
--- grok/trunk/doc/docindex.template 2008-06-25 16:33:25 UTC (rev 87773)
+++ grok/trunk/doc/docindex.template 2008-06-25 20:06:55 UTC (rev 87774)
@@ -1,41 +1,41 @@
+
<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?</a><br>
- <span class="linkdescr">Changes between each Grok release</span></p>
-
<p class="biglink"><a class="biglink" href="{{ pathto("tutorial") }}"
- >Tutorial</a><br>
- <span class="linkdescr">Get started with Grok</span></p>
+ >Grok Tutorial</a><br>
+ <span class="linkdescr">Get started with Grok.</span></p>
<p class="biglink"><a class="biglink" href="{{ pathto("grok_overview") }}"
>Grok Developer Notes</a><br>
- <span class="linkdescr">Learn more about Grok</span></p>
+ <span class="linkdescr">Overview of what's in Grok and how to use it.</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>
+
</td><td width="50%">
+ <p class="biglink"><a class="biglink" href="{{ pathto("changes") }}"
+ >What's new in Grok?</a><br>
+ <span class="linkdescr">Changes made in each Grok release.</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>
-
<p class="biglink"><a class="biglink" href="{{ pathto("naming_conventions") }}">Naming Conventions</a><br>
- <span class="linkdescr">how to name your stuff correctly</span></p>
+ <span class="linkdescr">How to name your stuff correctly.</span></p>
-
</td></tr>
</table>
+
<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>
- <span class="linkdescr">lists all sections and subsections</span></p>
+ <p class="biglink"><a class="biglink" href="{{ pathto("contents") }}">Table of Contents</a><br>
+ <span class="linkdescr">Lists all sections and subsections.</span></p>
<!--
<p class="biglink"><a class="biglink" href="{{ pathto("search") }}">Search page</a><br>
<span class="linkdescr">search this documentation</span></p>
-->
</td><td width="50%">
- <p class="biglink"><a class="biglink" href="{{ pathto("genindex") }}">General Index</a><br>
- <span class="linkdescr">all functions, classes, terms</span></p>
+ <p class="biglink"><a class="biglink" href="{{ pathto("genindex") }}">Index</a><br>
+ <span class="linkdescr">All functions, classes, terms.</span></p>
</td></tr>
</table>
@@ -59,3 +59,11 @@
</td></tr>
</table>
+
+ <p>
+ The <b>Official Grok Documentation</b> documents the core features of the
+ Grok framework. For further reading, the
+ <a href="http://grok.zope.org/documentation/">Community Grok Documentation</a>
+ contains deeper information on working with Grok, as well as using
+ additional packages with Grok that are not part of the core framework.
+ </p>
More information about the Checkins
mailing list